Questa pagina si applica a Apigee e Apigee ibridi.
Visualizza
documentazione di Apigee Edge.
Apigee offre un portale integrato e facile da usare per documentare e gestire l'accesso alle tue API. e promuovi la tua community di sviluppatori di app.
Tutti gli utenti di Apigee hanno accesso agli strumenti integrati di sviluppo del portale che consentono loro di creare il tuo portale per gli sviluppatori in modo rapido, offrendo un'alternativa 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 i seguenti vantaggi e funzionalità chiave:Funzionalità | Vantaggi |
---|---|
Sviluppo di contenuti di portali | Sviluppa i contenuti del tuo portale in modo rapido e semplice.
|
Aspetto e design del portale | Personalizza completamente l'aspetto del tuo portale con i fogli di stile 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 | Eseguire personalizzazioni avanzate del portale, tra cui:
|
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:
|
Protegge contro gli attacchi HTML, SQL o di backend injection |
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 di incorporare contenuti del portale in un iframe |
Include x-xss-protection: 1 intestazione XSS
|
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 delle app e le chiavi API
Quando un utente del portale completa il processo di registrazione dell'app sul portale integrato, il portale invia informazioni sull'app ad Apigee, inclusi il nome dell'app e i prodotti API associati all'app. Se Apigee registra l'app correttamente, Apigee 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 Apigee, non è archiviata sul 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 ulteriori informazioni, consulta la sezione Controllo dell'accesso alle API mediante la registrazione delle app.
Dove vengono memorizzati i dati dell'account sviluppatore di app
I dati dell'account sviluppatore vengono archiviati su Apigee, come segue:
- Con il provider di identità integrato, quando un utente del portale crea un account, le informazioni vengono archiviate nel provider di identità e vengono visualizzate nella pagina Utenti.
- Con il provider di identità SAML, quando un utente del portale accede al portale, nel provider di identità viene archiviato un record shadow delle informazioni che viene visualizzato nella pagina Utenti.
- Dopo che un utente del portale registra un'app per sviluppatori, i dati dell'account utente vengono sincronizzati e disponibili su Apigee nella pagina Sviluppatori.
I seguenti dati dell'account utente sono archiviati su Apigee:
- 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 è membro l'utente del portale (se hai effettuato la registrazione alla versione beta della funzionalità dei team)
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 appartiene lo sviluppatore.
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 relative informazioni vengono archiviate su Apigee, tra cui:
- Nome e descrizione del team degli 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
- Data e ora di creazione del team di sviluppatori
Un indirizzo email univoco generato automaticamente viene generato per il team di sviluppatori e funge da chiave primaria utilizzata da Apigee per identificare il team.
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 i temi di Material Design e SCSS.
Di seguito viene 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 presentate. Serve come home page predefinita del portale (index.html). Mostra l'utilizzo dei componenti del materiale angolare, come descritto in Aggiungere componenti del materiale angolare. |
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 sul tuo portale. Non puoi modificare direttamente i contenuti di questa pagina; non compare 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 tuo portale. Nota: i contenuti di questa pagina sono generati automaticamente in base alle app degli utenti 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. Vedi In che modo gli utenti del portale interagiscono con il tuo 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 compare nell'elenco delle pagine. " |
Termini e condizioni | Pagina di esempio relativa a Termini e condizioni. |