Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
I portali per sviluppatori con funzionalità di pubblicazione social vengono utilizzati sempre di più per la comunicazione con la community degli sviluppatori. Ciò include la comunicazione di contenuti statici, come la documentazione e i Termini e condizioni d'uso dell'API, nonché contenuti dinamici forniti 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, registrare gli sviluppatori e consentire agli sviluppatori di registrare le app. Esporre le tue API agli sviluppatori è solo una parte della creazione di una community davvero dinamica. Devi anche permettere alla tua community di sviluppatori di fornire feedback, richiedere assistenza e richieste di funzionalità e inviare i propri contenuti a cui altri sviluppatori possano accedere.
Apigee Edge ti fornisce un portale Servizi per gli sviluppatori che puoi utilizzare per creare e lanciare il tuo sito web personalizzato al fine di fornire tutti questi servizi alla tua community di sviluppo. Ogni cliente Edge può creare il proprio portale per gli sviluppatori, nel cloud o on-prem.
Il video seguente presenta il portale Apigee Developer Services.
La figura seguente mostra la home page del portale per gli sviluppatori predefinito:
Il portale per gli sviluppatori è essenzialmente un sistema di gestione dei contenuti (CMS) basato sul progetto open source Drupal (http://www.drupal.org). Drupal fornisce un insieme di funzionalità fondamentali sotto forma di moduli che ti consentono di creare facilmente i contenuti per i siti web e di gestirli.
Il portale per gli sviluppatori è subito disponibile per creare documentazione sulle API, supportare i blog e fornire forum organizzati in thread. Puoi anche personalizzare il portale per gli sviluppatori per soddisfare le tue esigenze specifiche. La personalizzazione consente di modificare l'aspetto e il modo in cui gli sviluppatori interagiscono con il portale.
Utilizzi il menu Drupal per eseguire la maggior parte delle personalizzazioni. Se accedi al portale come utente con privilegi amministrativi, nella parte superiore di ogni pagina del portale viene visualizzato il menu Drupal:
L'amministrazione controlla il processo in cui gli sviluppatori richiedono l'accesso al portale, il modo in cui gli sviluppatori registrano le app che accedono alle tue API, la modalità di assegnazione agli sviluppatori di ruoli e autorizzazioni specifici relativi alle tue API e quando revocare l'accesso degli sviluppatori alle API.
Inoltre, puoi utilizzare il portale per gli sviluppatori per configurare e controllare la monetizzazione. La monetizzazione offre agli sviluppatori l'accesso self-service a Fatturazione e report, Catalogo e piani e a impostazioni specifiche per la monetizzazione tramite il portale per gli sviluppatori.
Tipi di utenti del portale
La seguente immagine 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 conoscere le tue API tramite SmartDocumenti, registrare un account sul portale, registrare le app che utilizzano le tue API, interagire con la community di sviluppatori e visualizzare informazioni statistiche sull'utilizzo delle app in una dashboard.
-
Il team API è il provider di API che crea contenuti del portale, rende le API disponibili agli sviluppatori di app, fornisce documentazione sulle API e mette a disposizione degli sviluppatori un meccanismo per registrare le app e ottenere le chiavi API. Il team dell'API esegue la configurazione di base del portale per gli sviluppatori per:
- Configura richieste automatiche o manuali per chiavi API
- Gestisci la documentazione, i forum e i blog relativi all'API e, se vuoi, rivedi tutte le modifiche
- Gestire i commenti degli utenti e la moderazione dei forum
- Applica il controllo dell'accesso basato sui ruoli (RBAC) per controllare l'accesso alle funzionalità del portale. Ad esempio, un amministratore può abilitare i controlli per consentire a un utente registrato di creare post dei forum o utilizzare console di test
- Personalizza le notifiche via email inviate ad amministratori e sviluppatori per la creazione e l'approvazione degli utenti
- Personalizza i moduli web, ad esempio le pagine "Contattaci"
Non viene mostrato in questa figura un terzo tipo di utente del portale: il product manager API. Il product manager API è responsabile della definizione del modo in cui il team API crea il portale, tra cui:
- Definizione del modo in cui le API sono pacchettizzate nei prodotti
- Definizione delle regole per l'approvazione delle app
- Se la monetizzazione è abilitata sul portale, la definizione dei prezzi e dei piani di fatturazione per i prodotti basati su API. Per scoprire di più sulla monetizzazione, consulta l'articolo Panoramica della monetizzazione.
Personalizzazione del portale per gli sviluppatori
In qualità di provider di API, valuta come personalizzare il portale per gli sviluppatori per adattarlo al meglio alle tue API e per fornire alla tua community di sviluppatori le informazioni necessarie per l'utilizzo delle tue API. Ecco alcune considerazioni relative al portale personalizzato:
- Facile accesso alle API
- Documentazione, ad esempio guide illustrative e documenti di riferimento
- Contenuti forniti dalla community, ad esempio blog e forum di discussione
- Codice campione
- Una procedura di registrazione semplice che consente di approvare rapidamente nuovi sviluppatori, app e API
- Diritti e credenziali gestiti
- Controllo dell'accesso a più livelli
- Un aspetto e un design in linea con la tua organizzazione
Il portale è dotato di una configurazione di base predefinita. Ad esempio, il portale è configurato immediatamente in modo da consentire a chiunque di registrarsi come sviluppatore, ma un amministratore deve approvare ogni registrazione prima che lo sviluppatore possa accedervi. 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.
Di seguito sono riportati i passaggi della procedura di registrazione predefinita:
- Lo sviluppatore si registra tramite il portale per gli sviluppatori. In risposta, il portale invia un'email agli amministratori per approvare l'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 una chiave API univoca all'app.
- Lo sviluppatore passa la chiave API quando invia richieste alla tua API.
Questa esperienza preconfigurata è altamente personalizzabile. Ad esempio, puoi sostituire 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 di poter accedere per la prima volta.
Inoltre, hai il controllo completo sui contenuti disponibili sul portale per gli sviluppatori. All'istante, il portale per gli sviluppatori presenta contenuti di esempio come documentazione sulle API, post del blog e discussioni dei forum. Puoi fornire i tuoi contenuti e personalizzare l'aspetto di ogni tipo di contenuto.
Per ulteriori informazioni, vedi Personalizzare l'aspetto.
Amministrazione del portale per gli sviluppatori
Gli sviluppatori utilizzano il tuo portale per sviluppatori per accedere alla tua API e utilizzarla. Gli amministratori eseguono attività di gestione dell'account, tra cui:
- Personalizzazione del processo 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 gli sviluppatori, ma deve essere approvato da un amministratore tramite l'interfaccia utente del portale per gli sviluppatori. Gli amministratori possono anche creare sviluppatori direttamente sul portale. Il portale quindi invia automaticamente allo sviluppatore un'email per comunicargli che è stato creato un account per lui.
- Modifica dell'account sviluppatore. Ad esempio, gli amministratori possono modificare lo stato dell'account dell'utente da attivo a bloccato o cambiare 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 per creare libri o altri contenuti. Puoi anche modificare le autorizzazioni associate a un ruolo o crearne di nuovi.
Per maggiori informazioni, consulta Aggiungere e gestire account utente.
Riepilogo delle funzionalità del portale per gli sviluppatori
La seguente tabella contiene un riepilogo delle funzionalità del portale per gli sviluppatori:
| Funzionalità | Dettagli |
|---|---|
| Supporto del browser | |
|
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 |
|