Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
Apigee Edge offre un portale integrato e facile da usare per documentare e gestire l'accesso alle tue API e promuovere la community di sviluppatori di app.
Tutti gli utenti di Apigee Edge hanno accesso agli strumenti di sviluppo del portale integrato 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 Confronto delle funzionalità del portale per sviluppatori.
Guarda questo breve video per un'introduzione alla creazione e alla pubblicazione del portale integrato.
Funzionalità e vantaggi principali
Il portale integrato offre le seguenti funzionalità e i seguenti vantaggi principali:| Funzionalità | Vantaggi |
|---|---|
| Sviluppo dei contenuti del portale | Sviluppa i contenuti del portale in modo rapido e semplice.
|
| Aspetto del portale | Personalizza completamente l'aspetto del portale utilizzando fogli di stile SCSS e branding personalizzato. |
| Documentazione dell'API | Genera automaticamente la documentazione di riferimento dell'API in base alle specifiche OpenAPI. |
| Registrazione self-service | Fornisci la registrazione self-service per gli sviluppatori per creare app utilizzando le tue API. |
| Gestione segmenti di pubblico | Controlla chi può accedere ai contenuti del portale e alle API |
| Analytics | Configura Google Analytics e il monitoraggio di Analytics 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 le funzionalità integrate nel portale integrato.
| Funzionalità | Indirizzi |
|---|---|
| Richiede HTTPS e Transport Layer Security (TLS) | Applica la comunicazione criptata |
Include la registrazione del dominio apigee.io con l'elenco dei suffissi pubblici
|
Non consente l'impostazione di "supercookie" sui sottodomini di apigee.io
|
| Supporta la configurazione della policy di sicurezza dei contenuti (CSP) | Protegge da attacchi di cross-site scripting (XSS) e altri attacchi di inserimento di codice |
Richiede:
|
Protegge da attacchi di inserimento di codice HTML, SQL o backend |
Include l'intestazione XSS x-content-type-options: nosniff
|
Impedisce ai browser di provare a indovinare i tipi MIME |
Include l'intestazione XSS x-frame-options: deny
|
Non consente l'incorporamento dei contenuti del portale in un iframe |
Include l'intestazione XSS x-xss-protection: 1
|
Impedisce il caricamento delle pagine quando vengono rilevati attacchi di cross-site scripting (XSS) riflessi |
| Utilizza i token CSRF | Protegge dalla falsificazione di richiesta cross-site |
Sfrutta:
|
Protezioni dei dati dei clienti |
In che modo il portale integrato comunica con Edge
La maggior parte delle informazioni utilizzate dal portale per sviluppatori viene archiviata su Apigee Edge. Il portale funge da client per Edge. Se necessario, il portale per 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.
Le sezioni seguenti forniscono maggiori 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, quest'ultimo invia informazioni sull'app ad Apigee Edge, inclusi il nome dell'app e i prodotti API associati all'app. Se Edge registra l'app correttamente, restituisce una singola chiave API al portale. L'utente del portale utilizza questa chiave API per accedere ai prodotti API associati all'app.
Le informazioni sulle app e sulle chiavi API vengono archiviate solo su Edge; non vengono archiviate sul portale. Quando un utente del portale utilizza il portale per visualizzare le informazioni su un'app, ad esempio tramite la pagina Le mie app, il portale effettua una richiesta a Edge con la chiave API per accedere alle informazioni.
Allo stesso modo, 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 vengono archiviate su Edge, un amministratore di Edge può modificare le informazioni utilizzando l'interfaccia utente di Edge o l'API di gestione. 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ù, consulta Registrare le app e gestire le chiavi API.
Dove vengono archiviate le informazioni sull'account sviluppatore di app
Le informazioni sull'account sviluppatore vengono archiviate 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, viene archiviato un record shadow delle informazioni nel provider di identità e visualizzato nella pagina Utenti.
- Dopo che un utente del portale registra un'app sviluppatore, le informazioni dell'account utente vengono sincronizzate e rese disponibili su Edge nella pagina Sviluppatori.
Le seguenti informazioni sull'account utente vengono archiviate su Edge:
- Nome e cognome
- Indirizzo email
- Nome utente
- Stato dell'account del portale (attivo o inattivo)
- Ruolo del portale (utente autenticato, amministratore, altro)
- Autorizzazioni basate sui ruoli
- Team di cui l'utente del portale è membro (se hai eseguito la registrazione alla release beta della funzionalità dei team)
L'indirizzo email è la chiave primaria utilizzata da Edge per identificare lo sviluppatore e deve essere univoco. Dalla chiave primaria, Edge genera un ID sviluppatore univoco per ogni organizzazione a cui appartiene lo sviluppatore.
Per saperne di più, consulta Registrare gli sviluppatori di app.
Dove vengono archiviate le informazioni sul team di sviluppatori (beta)
Quando un utente del portale crea un team di sviluppatori sul portale, le informazioni sul team di sviluppatori vengono archiviate su Edge, tra cui:
- Nome e descrizione del team di sviluppatori
- Membri del team di sviluppatori e relativi ruoli
- App a cui è assegnato il team di sviluppatori
- Segmenti di pubblico assegnati al team di sviluppatori
- Ora in cui è stato creato il team di sviluppatori
Per il team di sviluppatori viene generato un indirizzo email univoco generato automaticamente che funge da chiave primaria utilizzata da Edge per identificare il team di sviluppatori.
Per saperne di più, consulta 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 da utilizzare come punto di partenza. Le pagine iniziali contengono contenuti demo 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 i temi di 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 in evidenza. Funge da home page predefinita per il portale (index.html). Mostra l'utilizzo dei componenti di Angular Material, come descritto in Aggiungere componenti di Angular Material. |
| Avvio rapido | Insieme di passaggi di avvio rapido che mostrano come personalizzare il portale. Fai clic su Avvio rapido nel portale di esempio per aggiungere contenuti alla pagina Inizia. |
| Inizia | Pagina di contenuti di esempio. Consulta la pagina Inizia nel portale di esempio per scoprire come modificare questa pagina e aggiungerla alla navigazione in alto. |
| API | Elenco delle API disponibili. Quando generi la documentazione di riferimento dell'API interattiva, 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 portale. Non puoi modificare direttamente i contenuti di questa pagina; non viene visualizzata nell'elenco delle pagine. Puoi modificare lo stile della pagina utilizzando l'editor dei temi del portale. |
| Le mie app | Elenco delle 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 viene visualizzata nell'elenco delle pagine. Puoi modificare lo stile della pagina utilizzando l'editor dei temi. |
| Accedi | Pagina di accesso per gli utenti registrati. I nuovi utenti possono registrarsi da questa pagina facendo clic su Accedi. Consulta 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; non viene visualizzata nell'elenco delle pagine. |
| Termini e condizioni | Pagina di esempio dei termini e delle condizioni. |
Supporto browser
I portali integrati di Apigee supportano le stesse versioni del browser di Apigee Edge.