Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info
I portali per sviluppatori con funzionalità di pubblicazione sui social vengono utilizzati sempre più spesso per la comunicazione con la community di sviluppatori. Sono inclusi la comunicazione di contenuti statici, come la documentazione dell'API e i termini e condizioni d'uso, nonché contenuti dinamici condivisi dalla community, come blog e forum.
In qualità di provider di API, hai bisogno di un modo per esporre le tue API, informare gli sviluppatori sulle tue API, registrarli e consentire loro di registrare le app. La pubblicazione delle API per gli sviluppatori è solo una parte della creazione di una community davvero dinamica. Inoltre, devi offrire alla tua community di sviluppatori un modo per fornire feedback, richiedere assistenza e funzionalità e inviare i propri contenuti a cui altri sviluppatori possono accedere.
Apigee Edge fornisce un portale per gli sviluppatori che puoi utilizzare per creare e lanciare il tuo sito web personalizzato per fornire tutti questi servizi alla tua community di sviluppo. Ogni cliente Edge può creare il proprio portale per sviluppatori, nel cloud o on-premise.
Il video seguente illustra il portale Apigee Developer Services.
La figura seguente mostra la home page del portale per sviluppatori predefinito:
Il portale per gli sviluppatori è essenzialmente un sistema di gestione dei contenuti (CMS) basato sul progetto Drupal (http://www.drupal.org) open source. Drupal fornisce un insieme di funzionalità di base sotto forma di moduli che ti consentono di creare facilmente i contenuti per i siti web, nonché di gestirli.
Il portale per gli sviluppatori consente di creare documentazione per le API, supporta i blog e fornisce forum organizzati in thread. Puoi anche personalizzare il portale per sviluppatori in base alle tue esigenze specifiche. La personalizzazione ti consente di modificare l'aspetto del portale e anche il modo in cui gli sviluppatori interagiscono con il portale.
Utilizza il menu di Drupal per eseguire la maggior parte delle personalizzazioni. Se accedi al portale come utente con privilegi amministrativi, il menu Drupal viene visualizzato nella parte superiore di ogni pagina del portale:
L'amministrazione controlla la procedura di richiesta di accesso al portale da parte degli sviluppatori, la modalità di registrazione delle app che accedono alle tue API, la modalità di assegnazione agli sviluppatori di ruoli e autorizzazioni specifici relativi alle tue API e il momento in cui revocare l'accesso degli sviluppatori alle API.
Inoltre, utilizzi il portale per sviluppatori per configurare e controllare la monetizzazione. La monetizzazione offre agli sviluppatori accesso self-service a Fatturazione e report, Catalogo e piani e alle impostazioni specifiche per la monetizzazione tramite il portale per gli sviluppatori.
Tipi di utenti del portale
L'immagine seguente mostra due tipi di utenti del portale:
- Gli sviluppatori costituiscono la community di utenti che creano app utilizzando le tue API. Gli sviluppatori di app utilizzano il portale per scoprire di più sulle tue API tramite SmartDocs, per registrare un account sul portale, per registrare le app che utilizzano le tue API, per interagire con la community di sviluppatori e per visualizzare informazioni statistiche sull'utilizzo delle loro app in una dashboard.
-
Il team API è il fornitore di API che crea i contenuti del portale, rende disponibili le proprie API per gli sviluppatori di app, fornisce la documentazione delle API e un meccanismo per consentire agli sviluppatori di registrare le app e ottenere le chiavi API. Il team API esegue la configurazione di base del
portale per sviluppatori per:
- Configurare richieste automatiche o manuali per le chiavi API
- Gestisci la documentazione, i forum e i blog delle API e, facoltativamente, rivedi tutte le modifiche
- Gestire i commenti degli utenti e la moderazione del forum
- Applica il controllo dell'accesso basato sui ruoli (RBAC) per controllare l'accesso alle funzionalità nel portale. Ad esempio, un amministratore può attivare i controlli per consentire a un utente registrato di creare post del forum o utilizzare console di test
- Personalizzare le notifiche via email per amministratori e sviluppatori per la creazione e le approvazioni degli utenti
- Personalizzare i moduli web, ad esempio le pagine "Contattaci"
In questa figura non è mostrato un terzo tipo di utente del portale: il gestore dei prodotti API. Il responsabile del prodotto API è responsabile della definizione del modo in cui il team di API crea il portale, ad esempio:
- Definire la modalità di pacchettizzamento delle API nei prodotti
- Definizione delle regole per l'approvazione delle app
- Se la monetizzazione è abilitata sul portale, definire i piani di prezzi e fatturazione per i prodotti API. Per saperne di più sulla monetizzazione, consulta la Panoramica della monetizzazione.
Personalizzazione del portale per gli sviluppatori
In qualità di fornitore di API, valuta come personalizzare il portale per gli sviluppatori in modo che si adatti al meglio alle tue API e fornisca le informazioni necessarie alla tua community di sviluppatori per utilizzare le tue API. Ecco alcune considerazioni per il tuo portale personalizzato:
- Accesso facile alle API
- Documentazione, come guide pratiche e documenti di riferimento
- Contenuti condivisi dalla community, come blog e forum di discussione
- Codice di esempio
- Una procedura di registrazione facile in cui è possibile approvare rapidamente nuovi sviluppatori, app e API
- Diritti e credenziali gestiti
- Controllo dell'accesso a più livelli
- Un aspetto e uno stile in linea con la tua organizzazione
Il portale è predefinito con una configurazione di base. Ad esempio, il portale è configurato per consentire a chiunque di registrarsi come sviluppatore, ma un amministratore deve approvare ogni registrazione prima che lo sviluppatore possa accedere al portale. Dopo l'approvazione della registrazione, lo sviluppatore può registrare un'app per richiedere una chiave API e utilizzare il portale per accedere alle risorse dell'API.
I passaggi della procedura di registrazione predefinita sono:
- Lo sviluppatore si registra tramite il portale per sviluppatori. In risposta, il portale invia un'email agli amministratori per l'approvazione dell'account.
- Un amministratore approva l'account e viene inviata un'email allo sviluppatore per informarlo che ora può accedere.
- Lo sviluppatore registra un'app e seleziona i prodotti API utilizzati dall'app. In risposta, il portale assegna all'app una chiave API univoca.
- Lo sviluppatore passa la chiave API quando invia richieste alla tua API.
Questa esperienza pronta all'uso è altamente personalizzabile. Ad esempio, puoi ignorare lo schema di registrazione e autorizzazione predefinito in modo che un nuovo sviluppatore venga approvato automaticamente e acceda dopo la registrazione. In alternativa, puoi richiedere allo sviluppatore di accettare una serie di termini e condizioni prima che possa accedere per la prima volta.
Hai anche il controllo completo sui contenuti disponibili nel portale per sviluppatori. Il portale per gli sviluppatori presenta contenuti di esempio come documentazione dell'API, post del blog e discussioni nel forum. Puoi fornire i tuoi contenuti e personalizzare l'aspetto di ciascun tipo di contenuto.
Per ulteriori informazioni, vedi Personalizzare l'aspetto.
Amministrare il portale per gli sviluppatori
Gli sviluppatori utilizzano il tuo portale per sviluppatori per accedere e utilizzare la tua API. Gli amministratori svolgono attività di gestione dell'account, ad esempio:
- Personalizzazione della procedura di registrazione degli sviluppatori, inclusi i campi di registrazione, il Captcha integrato e l'approvazione automatica o manuale
- Aggiunta o approvazione di sviluppatori. Per impostazione predefinita, qualsiasi sviluppatore può registrarsi tramite il portale per sviluppatori, ma deve essere approvato da un amministratore tramite l'interfaccia utente del portale per sviluppatori. Gli amministratori possono anche creare sviluppatori direttamente nel portale. Il portale invia automaticamente un'email allo sviluppatore per informarlo che è stato creato un account per lui.
- Modifica dell'account di uno sviluppatore. Ad esempio, gli amministratori possono modificare lo stato dell'account dell'utente da attivo a bloccato o modificare le informazioni del profilo dello sviluppatore, ad esempio il nome dell'azienda.
- Rimozione di uno sviluppatore. Gli amministratori possono disattivare o eliminare l'account di uno sviluppatore.
- Assegnazione di ruoli e autorizzazioni: gli amministratori possono assegnare un ruolo specifico a un account sviluppatore. Un ruolo è associato a varie autorizzazioni, ad esempio l'autorizzazione a creare libri o altri contenuti. Puoi anche modificare le autorizzazioni associate a un ruolo o creare nuovi ruoli.
Per ulteriori informazioni, vedi Aggiungere e gestire gli account utente.
Riepilogo delle funzionalità del portale per sviluppatori
La tabella seguente contiene un riepilogo delle funzionalità del portale per gli sviluppatori:
| Funzionalità | Dettagli |
|---|---|
| Supporto browser |
Consulta la sezione Software e versioni supportati. |
|
Registrazione utente |
|
|
Gestione utenti |
|
|
Aspetto del portale |
|
|
Gestione dei contenuti e della community |
|
|
Autorizzazioni |
|
|
Gestione delle chiavi API |
|
|
|
|
|
Blog |
|
|
Forum |
|
|
Documentazione |
|
|
Menu |
|
|
Cerca |
|
|
Verifica link |
|