Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza
documentazione di Apigee Edge.
La pubblicazione è il processo di messa a disposizione delle API per l'utilizzo da parte degli sviluppatori di app.
Video: il seguente video fornisce un'introduzione di alto livello alla pubblicazione di API.
La pubblicazione delle API prevede le seguenti attività, descritte in questo argomento:
- Crea i prodotti API che raggruppano le tue API.
- Registra gli sviluppatori di app.
- Registra le app degli sviluppatori.
- Fornisci la documentazione e l'assistenza dalla community per le tue API.
Attività 1: crea un prodotto API
La prima attività nella pubblicazione è creare un prodotto API. Un prodotto API è una raccolta Risorse API offerte come pacchetto agli sviluppatori di app per il consumo. Crea prodotti API utilizzando l'API o l'interfaccia utente di Apigee. (Consulta Che cos'è un prodotto API? per saperne di più sulle API products.)
In questa figura, l'API è composta da due prodotti, ciascuno contenente tre risorse API.
In qualità di provider di API, sei responsabile della creazione delle API e dei prodotti API per gestire controllo dell'accesso, restrizioni all'uso e qualsiasi altro requisito aziendale. Ad esempio, potresti:
- L'utente rilascia un prodotto API gratuito che consente l'accesso di sola lettura alle sue risorse API.
- Rilascia un secondo prodotto API a un prezzo ridotto che consenta l'accesso in lettura/scrittura alla stessa API di risorse come la versione gratuita, ma con un limite di accesso basso, ad esempio 1000 richieste al giorno.
- Rilascia un terzo prodotto API a un prezzo superiore che permetta l'accesso in lettura/scrittura allo stesso risorsa API, ma con un limite di accesso elevato.
La cosa importante da ricordare è che Apigee vi offre la flessibilità per creare prodotti API che soddisfano i requisiti aziendali delle tue API.
Per ulteriori informazioni sulla creazione di prodotti API, consulta Gestione dei prodotti API.
Attività 2: registra uno sviluppatore di app
Uno sviluppatore crea le app che utilizzano le tue API. Uno sviluppatore di app si registra su Apigee prima di poter registrare la propria app. Quando registrano l'app, ricevono una chiave API che concederà all'app l'accesso all'API.
Tramite la procedura di registrazione dell'app, puoi controllare chi può accedere alle tue API. In qualsiasi momento, puoi eliminare uno sviluppatore di app, con la conseguente invalidazione di tutte le chiavi API associate allo sviluppatore, quindi negare allo sviluppatore l'accesso alle tue API.
In qualità di fornitore di API, sei tu a decidere come registrare gli sviluppatori. Ad esempio, puoi utilizzare una procedura di registrazione manuale che richiede a un potenziale sviluppatore di contattare la tua organizzazione per registrarsi. Il potenziale sviluppatore deve fornire tutte le informazioni necessarie, ad esempio un indirizzo email, nome e cognome. Se approvi la richiesta dello sviluppatore, può utilizzare la UI di Apigee per registrare manualmente lo sviluppatore. Consulta l'articolo Registrazione di sviluppatori di app per altro ancora.
Attività 3: registra un'app per sviluppatori
Prima che un'app possa accedere alle tue API, deve essere registrata. Tuttavia, solo un sviluppatore registrato può registrare un'app.
Al momento della registrazione dell'app, lo sviluppatore seleziona uno o più prodotti API. Ad esempio, potresti pubblicare più prodotti API corrispondenti a diversi tipi di servizi e piani di prezzi. Lo sviluppatore di app può quindi scegliere tra i prodotti API disponibili.
In risposta alla registrazione dell'app su Apigee, Apigee assegna una chiave API univoca all'app. L'app deve passare tale chiave API come parte di ogni richiesta a una risorsa API. La chiave viene autenticata e, se valida, la richiesta viene concessa. In qualsiasi momento, in qualità di fornitore di servizi, puoi revocare la chiave in modo che l'app non possa più accedere alle tue API.
In qualità di fornitore di API, sei tu a decidere come registrare le app. Potresti:
- Utilizza una procedura manuale che richiede allo sviluppatore di contattare la tua organizzazione per registrare la propria app. In risposta, invierai allo sviluppatore la chiave API, eventualmente via email.
- Utilizza l'API Apigee per integrare la funzionalità di registrazione delle app e il caricamento delle chiavi nel tuo sito web.
- Per un account Apigee a pagamento, utilizza il portale Apigee Developer Services, che offre il supporto integrato per la registrazione delle app e l'invio delle chiavi API.
Per ulteriori informazioni, consulta Registrare le app e gestire le chiavi API.
Attività 4: documenta le tue API
Una considerazione importante per la pubblicazione di prodotti API è la documentazione e un meccanismo di feedback degli sviluppatori. I portali per sviluppatori con funzionalità di pubblicazione sui social vengono sempre più utilizzati per la comunicazione con la community di sviluppo. Sono inclusi la comunicazione di contenuti statici, come la documentazione dell'API e i termini e condizioni d'uso, nonché di contenuti dinamici condivisi dalla community, come blog e forum, oltre alle funzionalità di assistenza clienti.
Puoi creare il tuo sito web per implementare la documentazione o, se hai un account Apigee pagato, puoi utilizzare il portale Apigee Developer Services. Il portale ha supporto integrato per la documentazione, i blog, i forum e gli altri tipi di contenuti necessari per il supporto la tua community di sviluppatori.
SmartDocs ti consente di documentare le tue API nel portale Servizi per gli sviluppatori in modo da rendere la documentazione API completamente interattiva. La documentazione interattiva con SmartDocs consente agli utenti del portale di:
- Informazioni sull'API
- Invia una richiesta in tempo reale all'API
- Visualizzare una risposta in tempo reale restituita dall'API
Per ulteriori informazioni, consulta le seguenti sezioni:
- Portale integrato: Pubblicazione delle API
- Drupal 10: Documenta le tue API