Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Apigee Edge offre un portale integrato semplice da usare per documentare e gestire l'accesso alle tue API e per promuovere la tua community di sviluppatori di app.
Tutti gli utenti di Apigee Edge hanno accesso agli strumenti integrati di sviluppo del portale, che consentono loro di creare rapidamente il proprio portale per sviluppatori, fornendo un'alternativa allo sviluppo del portale basato su Drupal. Per un confronto delle funzionalità, consulta la pagina Confronto delle funzionalità del portale per gli sviluppatori.
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 | Sviluppa i contenuti del tuo portale in modo rapido e semplice.
|
| Aspetto e design del portale | Personalizza completamente l'aspetto del tuo portale utilizzando i fogli di stile SCSS e il branding personalizzato. |
| Documentazione relativa all'API | Genera automaticamente la documentazione di riferimento dell'API in base alle tue specifiche OpenAPI. |
| Registrazione self-service | Fornisci una registrazione self-service agli sviluppatori per consentire agli sviluppatori di creare app utilizzando le tue API. |
| Gestione segmenti di pubblico | Controlla chi può accedere ai contenuti e alle API del portale |
| Analytics | Configura il monitoraggio di Google Analytics e quello personalizzato. |
| Personalizzazioni avanzate | Esegui personalizzazioni avanzate del portale, tra cui:
|
Inizia a creare il tuo portale
In che modo Apigee gestisce la sicurezza nel portale integrato
La tabella seguente descrive in che modo Apigee gestisce la sicurezza tramite funzionalità integrate nel portale integrato.
| Funzionalità | Indirizzi |
|---|---|
| Richiede HTTPS e TLS (Transport Layer Security) | Applica le comunicazioni criptate |
Include la registrazione del dominio apigee.io con elenco dei suffissi pubblici
|
Non consente l'impostazione di "supercookie" nei sottodomini di apigee.io
|
| Supporta la configurazione dei criteri di sicurezza del contenuto (CSP). | Ti protegge da attacchi cross-site scripting (XSS) e altri attacchi di code-injection |
Richiede:
|
Protegge dagli attacchi HTML, SQL o backend injection |
Include intestazione XSS x-content-type-options: nosniff
|
Non consente ai browser di provare a indovinare i tipi MIME |
Include intestazione XSS x-frame-options: deny
|
Non consente di incorporare i contenuti del portale in un iframe |
Include intestazione XSS x-xss-protection: 1
|
Non consente il caricamento delle pagine quando rilevano attacchi cross-site scripting (XSS) |
| Utilizza i token CSRF | Protegge dalla contraffazione di richieste cross-site |
Leve:
|
Protezione dei dati dei clienti |
Modalità di comunicazione del portale integrato con Edge
La maggior parte delle informazioni utilizzate dal portale per gli sviluppatori è archiviata su Apigee Edge. Il portale agisce come client per Edge. Se necessario, il portale per gli sviluppatori invia una richiesta REST HTTP o HTTPS per recuperare o inviare informazioni a Edge. Ad esempio, quando un utente del portale registra una nuova app sul portale, quest'ultimo invia una richiesta a Edge per archiviare le informazioni sull'app.
Nelle sezioni che seguono vengono forniti maggiori dettagli.
Dove vengono archiviate la registrazione dell'app e le chiavi API
Quando un utente del portale completa il processo di registrazione dell'app sul portale integrato, quest'ultimo invia informazioni sull'app ad Apigee Edge, inclusi il nome dell'app e i prodotti API associati all'app. Se Edge registra correttamente l'app, Edge 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 archiviate solo su Edge, non sul portale. Quando un utente del portale utilizza il portale per visualizzare le informazioni su un'app, tramite la pagina Le mie app, ad esempio, il portale invia una richiesta a Edge 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 a Edge per l'archiviazione.
Poiché tutte le informazioni sulle app e sulle chiavi API sono archiviate su Edge, un amministratore di Edge può modificarle utilizzando la UI o l'API di gestione Edge. Ad esempio, un amministratore può:
- Aggiungere, rimuovere o modificare un'app dello sviluppatore
- Approvare o revocare una chiave API per un'app sviluppatore
Per ulteriori informazioni, vedi Registrare app e gestire le chiavi API.
Dove vengono memorizzati i dati dell'account sviluppatore dell'app
I dati dell'account sviluppatore vengono memorizzati su Edge, come segue:
- Utilizzando il provider di identità integrato, quando un utente del portale crea un account, le informazioni vengono archiviate nel provider di identità e visualizzate nella pagina Utenti.
- Utilizzando il provider di identità SAML, quando un utente del portale accede al portale, nel provider di identità viene memorizzato un record shadow delle informazioni che viene visualizzato nella pagina Utenti.
- Dopo che un utente del portale ha registrato un'app sviluppatore, i dati dell'account utente vengono sincronizzati e sono disponibili su Edge nella pagina Sviluppatori.
Le seguenti informazioni sugli account utente sono archiviate su Edge:
- Nome e cognome
- Indirizzo email
- Nome utente
- Stato dell'account del portale (attivo o non attivo)
- Ruolo del portale (utente autenticato, amministratore, altro)
- Autorizzazioni basate sul ruolo
- Team di cui l'utente del portale è membro (se hai eseguito la registrazione alla versione beta della funzionalità dei team)
L'indirizzo email è la chiave primaria utilizzata da Edge per identificare lo sviluppatore e ognuna deve essere univoca. Dalla chiave primaria, Edge genera un ID sviluppatore univoco per ogni organizzazione a cui appartiene lo sviluppatore.
Per ulteriori informazioni, vedi Registrare gli sviluppatori di app.
Dove vengono archiviate le informazioni del team di sviluppatori (beta)
Quando un utente del portale crea un team di sviluppatori sul portale, le relative informazioni vengono archiviate su Edge, tra cui:
- Nome e descrizione del team di sviluppatori
- Membri del team di sviluppatori e loro ruoli
- App a cui è assegnato il team di sviluppatori
- Segmenti di pubblico assegnati al team di sviluppatori
- Ora di creazione del team di sviluppatori
Per il team di sviluppatori viene generato un indirizzo email univoco generato automaticamente che funge da chiave principale utilizzata da Edge per identificare il team di sviluppatori.
Per ulteriori informazioni, vedi 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, ti viene fornito un insieme di pagine iniziali che puoi utilizzare come punto di partenza. Le pagine iniziali contengono contenuti dimostrativi che ti aiutano a ispirare lo sviluppo del tuo portale, sostituendo il testo e le immagini con i tuoi contenuti esclusivi. Il tema del portale di esempio utilizza il tema di material design e SCSS.
Di seguito è mostrata 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 mostrate. Serve come home page predefinita per il tuo portale (index.html). Illustra l'utilizzo di componenti materiale angolare, come descritto nella sezione Aggiungere componenti angolari di materiale. |
| Avvio rapido | Insieme di passaggi iniziali rapidi che mostrano come personalizzare il portale. Fai clic su Guida rapida nel portale di esempio per aggiungere contenuti alla pagina Inizia. |
| Inizia | Esempio di pagina di contenuti. Consulta la pagina Inizia nel portale di esempio per scoprire come modificare questa pagina e aggiungerla alla barra di navigazione in alto. |
| API | Elenco delle API disponibili. Quando generi la documentazione interattiva di riferimento dell'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 sul tuo portale. Non puoi modificare direttamente i contenuti di questa pagina perché non viene visualizzata nell'elenco delle pagine. Puoi modificare lo stile della pagina utilizzando l'editor del tema del portale. |
| Le mie applicazioni | Elenco di app registrate per un utente autorizzato. Vedi In che modo gli utenti del portale interagiscono con il portale. Nota: i contenuti di questa pagina vengono generati automaticamente in base alle app degli utenti registrati. Non puoi modificare direttamente i contenuti della pagina perché non viene visualizzata nell'elenco delle pagine. Puoi modificare lo stile della pagina utilizzando l'editor del tema. |
| Accedi | Pagina di accesso per gli utenti registrati. I nuovi utenti possono registrarsi da questa pagina facendo clic su Accedi. Vedi In che modo gli utenti del portale interagiscono con il portale. Nota: la pagina di accesso è inclusa automaticamente nel 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 perché non viene visualizzata nell'elenco delle pagine. |
| Termini e condizioni | Esempio di pagina relativa a Termini e condizioni. |
Supporto del browser
I portali integrati Apigee supportano le stesse versioni del browser di Apigee Edge.