Panoramica della pubblicazione

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info

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:

  1. Crea i prodotti API su Edge che raggruppano le tue API.
  2. Registra gli sviluppatori di app su Edge.
  3. Registra le app per sviluppatori su Edge.
  4. Fornisci documentazione e assistenza della community per le tue API.

Attività 1: crea un prodotto API su Edge

La prima attività di pubblicazione consiste nel creare un prodotto API. Un prodotto API è una raccolta di risorse API offerte come pacchetto per il consumo da parte degli sviluppatori di app. Crea prodotti API utilizzando l'API o l'interfaccia utente di gestione di Edge. Per saperne di più sui prodotti API, consulta Che cos'è un prodotto API?

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. L'icona e le risorse dell'API sono evidenziate. Una linea tratteggiata indica lo sviluppatore e un'icona di un'app creata dallo sviluppatore. Le frecce che vanno e vengono dall'app mostrano il flusso di richiesta e risposta a un'icona dell'API, con una chiave dell'app posizionata sopra la richiesta. L'icona e le risorse dell'API sono evidenziate. Sotto l'icona dell'API sono presenti due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località contiene risorse per /countries, /cities e /languages, mentre il prodotto Media contiene risorse per /books, /magazines e /movies. A destra dell'API sono riportate le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, server di app e un backend generico.

In questa figura, l'API è composta da due prodotti, ciascuno contenente tre risorse API.

In qualità di fornitore di API, sei responsabile della creazione delle API e dei prodotti API per gestire il controllo dell'accesso;accesso, le limitazioni di utilizzo e qualsiasi altro requisito aziendale. Ad esempio, potresti:

  • L'utente rilascia un prodotto API gratuito che consente l'accesso di sola lettura alle risorse dell'API.
  • L'API di Google Maps è disponibile a un prezzo ridotto che consente l'accesso in lettura/scrittura alle stesse risorse dell'API della versione gratuita, ma con un limite di accesso ridotto, ad esempio 1000 richieste al giorno.
  • L'utente può rilasciare un terzo prodotto API a un prezzo più elevato che consenta l'accesso in lettura/scrittura alla stessa risorsa API, ma con un limite di accesso elevato.

L'aspetto importante da ricordare è che Edge ti offre la flessibilità di creare prodotti API in grado di soddisfare i requisiti aziendali delle tue API.

Per ulteriori informazioni sulla creazione di prodotti API, consulta Creare prodotti API.

Attività 2: registra uno sviluppatore di app su Edge

Uno sviluppatore crea le app che utilizzano le tue API. Uno sviluppatore di app si registra su Apigee Edge prima di poter registrare la propria app. Quando registra la propria app, riceve una chiave API che consentirà all'app di accedere all'API.

Tramite la procedura di registrazione delle app, puoi controllare chi ha accesso 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.

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. L'icona dello sviluppatore è evidenziata. Una linea tratteggiata indica lo sviluppatore evidenziato e un'icona di un'app creata dallo sviluppatore. Le frecce che vanno e vengono dall'app mostrano il flusso di richiesta e risposta a un'icona dell'API, con una chiave dell'app posizionata sopra la richiesta. Sotto l'icona dell'API sono presenti due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località contiene risorse per /countries, /cities e /languages, mentre il prodotto Media contiene risorse per /books, /magazines e /movies. A destra dell'API sono riportate le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, server di app e un backend generico.

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, cognome e nome dell'azienda. Se approvi la richiesta dello sviluppatore, puoi utilizzare l'interfaccia utente di Edge Management per registrarlo manualmente. Per saperne di più, consulta Gestire gli sviluppatori di app.

Apigee fornisce anche strumenti che puoi utilizzare per automatizzare la procedura di registrazione degli sviluppatori. Ad esempio:

  • Utilizza l'API di gestione Apigee Edge per integrare la funzionalità di registrazione nel tuo sito web esistente. L'API Edge Management è un'API REST che puoi utilizzare per eseguire tutti gli aspetti della procedura di registrazione degli sviluppatori. Per saperne di più, consulta Utilizzare l'API Edge Management per pubblicare le API.
  • Utilizza il portale Apigee Developer Services per registrare gli sviluppatori. Il portale offre il supporto integrato per la registrazione degli sviluppatori, ma anche molte altre funzionalità per supportare le tue API. Per scoprire di più, consulta Che cos'è un portale per sviluppatori?

Attività 3: registra un'app per sviluppatori su Edge

Prima che un'app possa accedere alle tue API, deve essere registrata su Edge. Tuttavia, solo un sviluppatore registrato può registrare un'app su Edge.

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. Le frecce dell'app, della richiesta/risposta e della chiave API sono evidenziate. Una linea tratteggiata collega lo sviluppatore a un'icona di un'app creata dallo sviluppatore. Le frecce che vanno e vengono dall'app mostrano il flusso di richiesta e risposta a un'icona dell'API, con una chiave dell'app posizionata sopra la richiesta. L'icona e le risorse dell'API sono evidenziate. Sotto l'icona dell'API sono presenti due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località contiene risorse per /countries, /cities e /languages, mentre il prodotto Media contiene risorse per /books, /magazines e /movies. A destra dell'API sono riportate le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, server di app e un backend generico.

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 Edge, Edge assegna all'app una chiave API univoca. L'app deve passare questa chiave API in 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 Edge Management per integrare la funzionalità di registrazione delle app e il caricamento delle chiavi nel tuo sito web.
  • Per un account Edge 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, vedi Registrare le app e gestire le chiavi API.

Attività 4: documenta le tue API

Un aspetto importante per la pubblicazione di prodotti API è fornire documentazione e un meccanismo di feedback per gli 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é contenuti dinamici condivisi dalla community, come blog e forum, oltre alle funzionalità di assistenza clienti.

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. L'icona dello sviluppatore è evidenziata. Sotto lo sviluppatore è presente una casella che rappresenta un portale per sviluppatori. Il portale contiene documentazione, esempi, tutorial, riferimenti API e altro ancora. Il portale contiene anche blog, forum e un portale di assistenza. Una linea tratteggiata indica lo sviluppatore evidenziato e un'icona di un'app creata dall'autore. Le frecce che vanno e vengono dall'app mostrano il flusso di richiesta e risposta a un'icona dell'API, con una chiave dell'app posizionata sopra la richiesta. Sotto l'icona dell'API sono presenti due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località contiene risorse per /countries, /cities e /languages, mentre il prodotto Media contiene risorse per /books, /magazines e /movies. A destra dell'API sono riportate le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, server di app e un backend generico.

Puoi creare il tuo sito web per implementare la documentazione o, se hai un account Edge pagato, puoi utilizzare il portale Apigee Developer Services. Il portale offre il supporto integrato per la documentazione, i blog, i forum e altri tipi di contenuti necessari per supportare 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

Ad esempio, la figura seguente mostra un'API documentata nel portale utilizzando SmartDocs. Questa API fornisce informazioni meteo per una località specifica:

Un argomento del metodo dell'API SmartDocs che ti consente di chiamare un'API meteo facendo clic su un pulsante nell'argomento.

Lo sviluppatore inserisce un valore per il parametro di query "w" per specificare la posizione, quindi fa clic sul pulsante Invia la richiesta per visualizzare la richiesta e la risposta in tempo reale. Se crei una documentazione interattiva sulle tue API, sarà più facile per gli utenti del portale apprendere, testare e valutare le tue API.

L'API Edge Management è un'API REST che ti consente di accedere ai servizi API utilizzando qualsiasi client HTTP. Apigee utilizza SmartDocs per creare documentazione interattiva per l'API di gestione di Edge. Consulta la documentazione dell'API qui.

Per ulteriori informazioni, consulta Utilizzare SmartDocs per documentare le API.