Creazione del portale integrato

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Apigee offre un portale integrato e facile da usare per documentare e gestire l'accesso alle tue API e promuovere la tua community di sviluppatori di app.

Tutti gli utenti di Apigee hanno accesso agli strumenti di sviluppo del portale integrati che consentono loro di creare rapidamente il proprio portale per sviluppatori, offrendo un'alternativa allo sviluppo di portali basati su Drupal. Per un confronto delle funzionalità, consulta la sezione Confronto delle funzionalità del portale per gli sviluppatori.

Video: guarda questo breve video per un'introduzione alla creazione e alla pubblicazione del tuo portale integrato.

Funzionalità e vantaggi principali

Il portale integrato offre le seguenti funzionalità e vantaggi principali:
Funzionalità Vantaggi
Sviluppo dei contenuti del portale Sviluppare i contenuti del portale in modo facile e veloce.
  • Crea pagine con un editor di pagine facile da usare
  • Utilizzare Markdown e HTML per comporre contenuti
  • Aggiungi menu per navigare nel portale
Aspetto e design del portale Personalizza completamente l'aspetto del tuo portale utilizzando gli stili SCSS e il branding personalizzato.
Documentazione dell'API Genera automaticamente la documentazione di riferimento dell'API in base alle tue specifiche OpenAPI.
Registrazione self-service Fornisci agli sviluppatori la registrazione self-service per creare app utilizzando le tue API.
Gestione segmenti di pubblico Controlla chi può accedere ai contenuti e alle API del portale
Analytics Configurare Google Analytics e il monitoraggio personalizzato di Analytics.
Personalizzazioni avanzate Esegui personalizzazioni avanzate del portale, tra cui:
  • Personalizza il tuo dominio
  • Aggiungi campi di registrazione personalizzati
  • Espandere il portale utilizzando script
  • Configurare l'email

In che modo Apigee gestisce la sicurezza nel portale integrato

La tabella seguente descrive in che modo Apigee gestisce la sicurezza tramite le funzionalità integrate nel portale integrato.

Funzionalità Indirizzi
Richiede HTTPS e TLS (Transport Layer Security) Forza la comunicazione criptata
Include la registrazione del dominio apigee.io con l'elenco dei suffissi pubblici Non sono consentiti i "supercookie" dall'impostazione nei sottodomini di apigee.io
Richiede:
  • Pulizia dell'input del modulo
  • Iniezione di codice JavaScript a livello di sito limitata agli amministratori
Protegge da attacchi di tipo HTML, SQL o di inserimento di codice nel backend
Include x-content-type-options: nosniff intestazione XSS Non consente ai browser di provare a indovinare i tipi MIME
Include x-frame-options: deny intestazione XSS Non consente l'inserimento dei contenuti del portale in un iframe
Include l'intestazione XSS x-xss-protection: 1 Non consente il caricamento delle pagine quando rilevano attacchi cross-site scripting (XSS) riflessi
Utilizza token CSRF Protegge contro la falsificazione delle richieste tra siti
Sfrutta: Protezione dei dati dei clienti

In che modo il portale integrato comunica con Apigee

La maggior parte delle informazioni utilizzate dal portale per gli sviluppatori è archiviata su Apigee. Il portale funge da client per Apigee. Se necessario, il portale per gli sviluppatori invia una richiesta REST HTTP o HTTPS per recuperare o inviare informazioni ad Apigee. Ad esempio, quando un utente del portale registra una nuova app al suo interno, il portale invia una richiesta ad Apigee per archiviare le informazioni relative all'app.

Le sezioni seguenti forniscono ulteriori dettagli.

Dove vengono archiviate la registrazione dell'app e le chiavi API

Quando un utente del portale completa la procedura di registrazione dell'app sul portale integrato, il portale invia informazioni sull'app ad Apigee, tra cui il nome dell'app e i prodotti API associati. Se Apigee registra l'app correttamente, restituisce una singola chiave API al portale. L'utente del portale utilizza la chiave API per accedere ai prodotti API associati all'app.

Le informazioni sulle app e sulle chiavi API vengono memorizzate solo in Apigee e non nel portale. Quando un utente del portale utilizza il portale per visualizzare informazioni su un'app, ad esempio tramite la pagina Le mie app, il portale invia una richiesta ad Apigee con la chiave API per accedere alle informazioni.

Analogamente, quando un utente del portale aggiunge, rimuove o modifica un'app, il portale invia le modifiche ad Apigee affinché vengano archiviate.

Poiché tutte le informazioni sulle app e sulle chiavi API sono archiviate su Apigee, un amministratore Apigee può modificarle utilizzando la UI o l'API di gestione Apigee. Ad esempio, un amministratore può:

  • Aggiungere, rimuovere o modificare un'app sviluppatore
  • Approvare o revocare una chiave API per un'app sviluppatore

Per saperne di più, vedi Controllo dell'accesso alle API mediante la registrazione delle app.

Dove vengono memorizzati i dati dell'account dello sviluppatore di app

I dati dell'account sviluppatore vengono archiviati su Apigee come segue:

I seguenti dati dell'account utente vengono archiviati in Apigee:

L'indirizzo email è la chiave primaria utilizzata da Apigee per identificare lo sviluppatore e ogni indirizzo deve essere univoco. Dalla chiave primaria, Apigee genera un ID sviluppatore univoco per ogni organizzazione a cui lo sviluppatore appartiene.

Per maggiori informazioni, vedi Registrare gli sviluppatori di app.

Dove vengono archiviate le informazioni del team di sviluppatori (beta)

Quando un team di sviluppatori viene creato sul portale da un utente del portale, le informazioni del team di sviluppatori vengono memorizzate in Apigee, tra cui:

  • Nome e descrizione del team sviluppatore
  • Membri del team di sviluppo e relativi ruoli
  • App a cui è assegnato il team di sviluppatori
  • Segmenti di pubblico assegnati al team di sviluppo
  • Data e ora di creazione del team di sviluppatori

Viene generato un indirizzo email univoco e generato automaticamente per il team di sviluppatori e funge da chiave primaria utilizzata da Apigee per identificare il team di sviluppatori.

Per ulteriori informazioni, consulta gli articoli Condividere la responsabilità di un'app utilizzando i team di sviluppatori (beta) e Gestire i team di sviluppatori.

Informazioni sul portale di esempio

Quando crei un nuovo portale, viene fornito un insieme di pagine iniziali che puoi utilizzare come punto di partenza. Le pagine iniziali includono contenuti dimostrativi per aiutarti a sviluppare il tuo portale mentre sostituisci il testo e le immagini con i tuoi contenuti unici. Il tema del portale di esempio utilizza la tecnologia di temi Material Design e SCSS.

Di seguito è riportata la home page del portale di esempio.

Le pagine iniziali fornite con il portale di esempio includono:

Pagina Descrizione
Home Home page del portale che descrive le API presentate. Serve come home page predefinita del portale (index.html). Mostra l'utilizzo dei componenti Angular Material, come descritto in Aggiungere componenti Angular Material.
Inizia Pagina di contenuti di esempio. Scopri come modificare questa pagina e aggiungerla alla barra di navigazione superiore seguendo il tutorial.
API Elenco delle API disponibili. Quando generi una documentazione interattiva di riferimento per le API, i link ai contenuti vengono aggiunti automaticamente a questa pagina.

Nota: i contenuti di questa pagina vengono generati automaticamente in base alle API che pubblichi nel tuo portale. Non puoi modificare direttamente i contenuti di questa pagina, che non viene visualizzata nell'elenco delle pagine. Puoi modificare lo stile della pagina utilizzando l'editor dei temi per il portale.
Le mie app Elenco di app registrate per un utente autorizzato. Consulta In che modo gli utenti del portale interagiscono con il portale.

Nota: i contenuti di questa pagina vengono generati automaticamente in base alle app utente registrate. Non puoi modificare direttamente i contenuti della pagina. non compare nell'elenco delle pagine. Puoi modificare lo stile della pagina utilizzando l'editor di temi.
Accedi Pagina di accesso per gli utenti registrati. I nuovi utenti possono registrarsi da questa pagina facendo clic su Accedi. Consulta l'articolo In che modo gli utenti del portale interagiscono con il portale.

Nota: la pagina Accedi è inclusa automaticamente nel tuo portale. Puoi personalizzare il logo nella pagina di accesso e aggiungere campi di registrazione personalizzati alla pagina Crea account. Non puoi modificare direttamente i contenuti della pagina. non compare nell'elenco delle pagine. "
Termini e condizioni Pagina di esempio relativa a Termini e condizioni.