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 gli sviluppatori, fornendo un'alternativa allo sviluppo del portale basato su Drupal. Per un confronto delle funzionalità, vedi Confronto delle funzionalità del portale per gli sviluppatori.

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 portale in modo semplice e veloce.
  • Creare pagine utilizzando l'editor di pagine facile da usare
  • Utilizzare Markdown e HTML per comporre i contenuti
  • Aggiungere menu per navigare nel portale
Aspetto del portale Personalizza completamente l'aspetto del tuo portale utilizzando fogli di stile SCSS e branding personalizzato.
Documentazione dell'API Genera automaticamente la documentazione di riferimento delle API in base alle specifiche OpenAPI.
Registrazione self-service Fornisci la registrazione self-service agli sviluppatori per creare app utilizzando le tue API.
Gestione segmenti di pubblico Controllare chi può accedere ai contenuti e alle API del portale
Analytics Configura Google Analytics e il monitoraggio delle analisi personalizzate.
Personalizzazioni avanzate Esegui personalizzazioni avanzate del portale, tra cui:
  • Personalizzare il dominio
  • Aggiungere campi di registrazione personalizzati
  • Estendere il portale utilizzando gli script
  • Configurare l'email

Come Apigee gestisce la sicurezza nel portale integrato

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

Funzionalità Indirizzi
Richiede HTTPS e Transport Layer Security (TLS) Impone la comunicazione criptata
Include la registrazione del dominio apigee.io con l'elenco dei suffissi pubblici Impedisce l'impostazione di "supercookie" sui sottodomini di apigee.io
Richiede:
  • Purificazione dell'input del modulo
  • L'inserimento di JavaScript a livello di sito è limitato agli amministratori
Protegge da attacchi di iniezione HTML, SQL o di backend
Include l'intestazione x-content-type-options: nosniff XSS Impedisce ai browser di provare a indovinare i tipi MIME
Include l'intestazione x-frame-options: deny XSS Non consente l'incorporamento dei contenuti del portale in un iframe
Include l'intestazione x-xss-protection: 1 XSS Impedisce il caricamento delle pagine quando rileva attacchi di cross-site scripting (XSS) riflessi
Utilizza i token CSRF Protegge dalla falsificazione delle richieste cross-site
Leverages: Protezioni dei dati dei clienti

Come comunica il portale integrato 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 sviluppatori invia una richiesta REST HTTP o HTTPS per recuperare informazioni da Apigee o inviarle. Ad esempio, quando un utente del portale registra una nuova app sul portale, quest'ultimo invia una richiesta ad Apigee per memorizzare 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, 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, 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 memorizzate solo su Apigee, non sul portale. Quando un utente del portale lo utilizza 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 per essere archiviate.

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

  • Aggiungere, rimuovere o modificare un'app per sviluppatori
  • 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 sviluppatore di app

I dati dell'account sviluppatore sono memorizzati su Apigee nel seguente modo:

Su Apigee vengono memorizzate le seguenti informazioni dell'account utente:

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 saperne di più, vedi Registrare gli sviluppatori di app.

Dove vengono memorizzate le informazioni del team di sviluppo (anteprima)

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

  • Nome e descrizione del team di sviluppatori
  • Membri del team di sviluppo e relativi ruoli
  • App a cui è assegnato il team di sviluppo
  • 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 e generato automaticamente, che funge da chiave primaria utilizzata da Apigee per identificare il team di sviluppatori.

Per maggiori informazioni, vedi Condividere la responsabilità di un'app utilizzando i team di sviluppatori (anteprima) 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 ispirare lo sviluppo del tuo portale mentre sostituisci il testo e le immagini con i tuoi contenuti unici. Il tema del portale di esempio utilizza temi 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 in evidenza. Funge da home page predefinita per il portale (index.html). Mostra l'utilizzo dei componenti Angular Material, come descritto in Aggiungere componenti Angular Material.
Inizia Pagina dei contenuti di esempio. Scopri come modificare questa pagina e aggiungerla alla navigazione principale seguendo il tutorial.
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 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 di 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, che non viene visualizzata 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 Crea un account. 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, che non viene visualizzata nell'elenco delle pagine. "
Termini e condizioni Pagina di esempio dei termini e condizioni.