Creazione del portale integrato

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

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

Tutti gli utenti di Apigee hanno accesso agli strumenti di sviluppo integrati 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.

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 funzioni e vantaggi principali:
Selezione delle Vantaggi
Sviluppo dei contenuti dei portali Sviluppa i contenuti del tuo 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 struttura del portale Personalizza completamente l'aspetto del tuo portale utilizzando 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
Analisi Configurare Google Analytics e il monitoraggio personalizzato.
Personalizzazioni avanzate Consente di eseguire personalizzazioni avanzate del portale, tra cui:
  • Personalizzare il dominio
  • Aggiungi campi di registrazione personalizzati
  • Estendi il portale utilizzando gli script
  • Configura la tua email

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.

Selezione delle Indirizzi
Richiede HTTPS e TLS (Transport Layer Security) Impone la comunicazione criptata
Include la registrazione del dominio apigee.io con elenco dei suffissi pubblici Non consente l'impostazione dei "supercookie" nei sottodomini di apigee.io
Richiede:
  • Sanitizzazione dell'input del modulo
  • Iniezione di codice JavaScript in tutto il sito riservata agli amministratori
Protezione da attacchi HTML, SQL o di iniezione di 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 di incorporare 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)
Utilizza i token CSRF Previeni la falsificazione di richieste tra siti
Leva: Protezioni dei dati dei clienti

In che modo il portale integrato comunica con Apigee

La maggior parte delle informazioni utilizzate dal portale per gli sviluppatori viene 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 informazioni da Apigee o inviare informazioni. Ad esempio, quando un utente registra una nuova app al portale, quest'ultimo invia una richiesta ad Apigee per archiviare informazioni sull'app.

Le sezioni seguenti forniscono ulteriori 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, inclusi il nome dell'app e i prodotti API associati. Se Apigee registra correttamente l'app, 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 sul portale. Quando un utente del portale utilizza il portale per visualizzare informazioni su un'app, tramite la pagina Le mie app, ad esempio, 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 dello sviluppatore
  • Approvare o revocare una chiave API per un'app sviluppatore

Per maggiori informazioni, consulta Controllare l'accesso alle API registrando le app.

Dove vengono memorizzati i dati dell'account sviluppatore di app

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

I seguenti dati dell'account utente sono archiviati su Apigee:

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

Per ulteriori informazioni, consulta l'articolo 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 Apigee, tra cui:

  • Nome e descrizione del team di sviluppo
  • 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 primaria utilizzata da Apigee per identificare il team di sviluppatori.

Per maggiori informazioni, leggi 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, ti viene fornito un insieme di pagine iniziali che puoi utilizzare come punto di partenza. Le pagine iniziali includono contenuti dimostrativi che ti aiutano a ispirare lo sviluppo del tuo portale man mano che sostituisci il testo e le immagini con i tuoi contenuti esclusivi. Il tema del portale di esempio utilizza i temi di Material Design e SCSS.

Di seguito è visualizzata 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. Funge da pagina iniziale predefinita per il tuo portale (index.html). Illustra l'utilizzo di componenti del materiale angolare, come descritto in Aggiungere componenti angolari del materiale.
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 la documentazione di riferimento interattiva 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 compare nell'elenco delle pagine. Puoi modificare lo stile della pagina utilizzando l'editor di temi del portale.
Le mie app Elenco di app registrate per un utente autorizzato. Consulta l'articolo 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 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 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 compare nell'elenco delle pagine. "
Termini e condizioni Pagina di esempio relativa a Termini e condizioni.