Panoramica della pubblicazione

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

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 generale alla pubblicazione tramite API.

La pubblicazione delle API prevede le seguenti attività, descritte in questo argomento:

  1. Crea su Edge i prodotti API 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 dalla community per le tue API.

Attività 1: crea un prodotto API su Edge

La prima attività della pubblicazione è creare un prodotto API. Un prodotto API è una raccolta di risorse API offerte come pacchetto agli sviluppatori di app per l'utilizzo. Crea prodotti API utilizzando l'API o l'interfaccia utente di gestione perimetrale. Per saperne di più sui prodotti basati su API, consulta Che cos'è un prodotto basato su API?

Diagramma sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. L'icona dell'API e le risorse sono evidenziate. Una linea tratteggiata rimanda dallo sviluppatore all'icona di un'app creata dallo sviluppatore. Le frecce da e verso l'app mostrano il flusso di richiesta e risposta a un'icona API, con una chiave dell'app posizionata sopra la richiesta. L'icona dell'API e le risorse sono evidenziate. Sotto l'icona dell'API ci sono due insiemi di percorsi delle risorse raggruppati in due prodotti API: Prodotto località e Prodotto multimediale. Il prodotto Posizione include risorse per /countries, /cities e /languages, mentre il prodotto Media dispone di risorse per /books, /magazines e /movies. A destra dell'API sono presenti le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, i server delle app e un backend generico.

In questa figura, l'API è costituita 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 il controllo dell'accesso, le limitazioni di utilizzo e qualsiasi altro requisito aziendale. Ad esempio, potresti:

  • Rilascia un prodotto API senza costi che consente l'accesso di sola lettura alle relative risorse API.
  • Rilascia un secondo prodotto API a un prezzo ridotto che consente l'accesso in lettura/scrittura alle stesse risorse API della versione senza costi, ma con un limite di accesso basso, ad esempio 1000 richieste al giorno.
  • Rilascia un terzo prodotto API a un prezzo più elevato che consente l'accesso in lettura/scrittura alla stessa risorsa API ma con un limite di accesso elevato.

La cosa importante da ricordare è che Edge ti offre la flessibilità necessaria per creare prodotti API che soddisfano i requisiti aziendali delle tue API.

Per saperne di più sulla creazione di prodotti basati su API, consulta la sezione Creare prodotti basati su 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 l'app. Quando registra l'app, riceve una chiave API che gli concede l'accesso all'API.

Tramite il processo di registrazione dell'app, puoi controllare chi può accedere alle tue API. In qualsiasi momento puoi eliminare uno sviluppatore di app, il che rende non valide tutte le chiavi API associate allo sviluppatore, negando così l'accesso alle tue API.

Diagramma sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. L'icona sviluppatore è evidenziata. Una linea tratteggiata collega lo sviluppatore evidenziato a un'icona di un'app creata dallo sviluppatore. Le frecce da e verso l'app mostrano il flusso di richiesta e risposta a un'icona API, con una chiave dell'app posizionata sopra la richiesta. Sotto l'icona dell'API ci sono due insiemi di percorsi delle risorse raggruppati in due prodotti API: Prodotto località e Prodotto multimediale. Il prodotto Posizione include risorse per /countries, /cities e /languages, mentre il prodotto Media dispone di risorse per /books, /magazines e /movies. A destra dell'API sono presenti le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, i server delle app e un backend generico.

In qualità di provider 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 indirizzo email, nome, cognome e nome dell'azienda. Se approvi la richiesta dello sviluppatore, puoi utilizzare l'interfaccia utente di gestione perimetrale per registrare manualmente lo sviluppatore. Per ulteriori informazioni, consulta Gestire gli sviluppatori di app.

Apigee fornisce anche strumenti che puoi utilizzare per automatizzare il processo 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 del processo di registrazione degli sviluppatori. Consulta Utilizzo dell'API Edge Management per pubblicare le API per ulteriori informazioni.
  • Utilizza il portale Servizi per gli sviluppatori Apigee per registrare gli sviluppatori. Il portale include il supporto integrato per la registrazione come sviluppatore, ma anche molte altre funzionalità per il supporto delle tue API. Per saperne di più, consulta Che cos'è un portale per gli sviluppatori?.

Attività 3: registra un'app sviluppatore su Edge

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

Diagramma 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 all'icona di un'app creata dallo sviluppatore. Le frecce da e verso l'app mostrano il flusso di richiesta e risposta a un'icona API, con una chiave dell'app posizionata sopra la richiesta. L'icona dell'API e le risorse sono evidenziate. Sotto l'icona dell'API ci sono due insiemi di percorsi delle risorse raggruppati in due prodotti API: Prodotto località e Prodotto multimediale. Il prodotto Posizione include risorse per /countries, /cities e /languages, mentre il prodotto Media dispone di risorse per /books, /magazines e /movies. A destra dell'API sono presenti le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, i server delle app e un backend generico.

Al momento della registrazione dell'app, lo sviluppatore seleziona uno o più prodotti basati su API. Ad esempio, potresti pubblicare più prodotti basati su API corrispondenti a diversi tipi di servizi e piani tariffari. Lo sviluppatore dell'app può quindi scegliere dall'elenco dei prodotti API disponibili.

In risposta alla registrazione dell'app su Edge, Edge assegna all'app una chiave API univoca, che deve passare come parte di ogni richiesta a una risorsa API. La chiave è 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 provider di API, sei tu a decidere come registrare le app. Cosa puoi fare:

  • Utilizza una procedura manuale che richiede che uno sviluppatore contatti la tua organizzazione per registrare la sua app. In risposta, devi inviare allo sviluppatore la chiave API, possibilmente via email.
  • Utilizza l'API Edge Management per integrare la funzionalità di registrazione delle app e la distribuzione delle chiavi nel tuo sito web.
  • Per un account Edge a pagamento, utilizza il portale Apigee Developer Services che include supporto integrato per la registrazione delle app e la distribuzione delle chiavi API.

Per maggiori informazioni, consulta la sezione Registrare app e gestire le chiavi API.

Attività 4: documenta le tue API

Una considerazione importante per la pubblicazione di prodotti API è la fornitura di documentazione e di un meccanismo di feedback degli sviluppatori. I portali per sviluppatori con funzionalità di pubblicazione social vengono utilizzati sempre più spesso per la comunicazione con la community di 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, nonché funzionalità di assistenza clienti.

Diagramma sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. L'icona sviluppatore è evidenziata. Sotto lo sviluppatore c'è una casella che rappresenta un portale per gli sviluppatori. Il portale contiene documentazione, esempi, tutorial, riferimenti per le API e altro ancora. Il portale contiene anche blog, forum e un portale di assistenza. Una linea tratteggiata collega lo sviluppatore evidenziato a un'icona di un'app creata dallo sviluppatore. Le frecce da e verso l'app rimandano il flusso di richiesta e risposta a un'icona API, con una chiave dell'app posizionata sopra la richiesta. Sotto l'icona dell'API ci sono due insiemi di percorsi delle risorse raggruppati in due prodotti API: Prodotto località e Prodotto multimediale. Il prodotto Posizione include risorse per /countries, /cities e /languages, mentre il prodotto Media dispone di risorse per /books, /magazines e /movies. A destra dell'API sono presenti le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, i server delle app e un backend generico.

Puoi creare il tuo sito web per eseguire il deployment della documentazione oppure, se hai un account Edge a pagamento, puoi utilizzare il portale Apigee Developer Services. Il portale include il supporto integrato per la documentazione, i blog, i forum e altri tipi di contenuti necessari per supportare la tua community di sviluppatori.

SmartDocs consente di documentare le API sul portale Developer Services in modo da rendere la documentazione relativa alle API completamente interattiva. La documentazione interattiva di SmartDocuments consente agli utenti del portale di:

  • Ulteriori informazioni sull'API
  • Invia una richiesta in tempo reale all'API
  • Visualizza una risposta in tempo reale restituita dall'API

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

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

Lo sviluppatore inserisce un valore per il parametro di query "w" per specificare la località, quindi fa clic sul pulsante Invia la richiesta per visualizzare la richiesta e la risposta in tempo reale. Creando una documentazione interattiva sulle tue API, consenti agli utenti del portale di imparare, testare e valutare facilmente le tue API.

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

Per ulteriori informazioni, consulta Utilizzo di SmartDocumenti per documentare le API.