Panoramica della pubblicazione

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

La pubblicazione è il processo con cui le API diventano disponibili per il consumo agli sviluppatori di app.

Video: il seguente video offre un'introduzione generale alla pubblicazione tramite API.

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

  1. Crea i prodotti API che raggruppano le tue API.
  2. Registra gli sviluppatori di app.
  3. Registrazione di app sviluppatore.
  4. 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 di risorse API offerte come pacchetto agli sviluppatori di app per il consumo. Crea prodotti API utilizzando l'API o la UI Apigee. (Consulta la sezione Che cos'è un prodotto API? per saperne di più sui prodotti API.)

Un diagramma di 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 punta dallo sviluppatore all'icona di un'app creata dallo sviluppatore. Le frecce da e per tornare all'app mostrano il flusso di richiesta e risposta verso un'icona API, con una chiave 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 Location e Prodotto multimediale. Il prodotto Location dispone di risorse per /countries, /cities e /languages, mentre il prodotto Media offre risorse per /books, /magazines e /movies. A destra dell'API sono indicate le risorse di backend chiamate dall'API, tra cui un database, un bus di servizi aziendali, server di 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 di API e prodotti API per gestire il controllo dell'accesso, le limitazioni di utilizzo e qualsiasi altro requisito aziendale. Ad esempio, potresti:

  • Rilascia un prodotto API gratuito che consente l'accesso di sola lettura alle relative risorse API.
  • Rilascia un secondo prodotto API a un prezzo ridotto che consenta l'accesso in lettura/scrittura alle stesse risorse API della 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 consente l'accesso in lettura/scrittura alla stessa risorsa API, ma con un limite di accesso elevato.

È importante ricordare che Apigee vi offre la flessibilità per creare prodotti API che soddisfano i requisiti aziendali delle 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 sua app. Quando registra l'app, riceve una chiave API che le darà accesso all'API.

Tramite la procedura di registrazione dell'app, puoi controllare chi può accedere alle tue API. Puoi eliminare in qualsiasi momento uno sviluppatore di app. Questa azione invalida tutte le chiavi API associate allo sviluppatore, impedendogli di conseguenza l'accesso alle tue API.

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. È evidenziata l'icona sviluppatore. Una linea tratteggiata che rimanda dallo sviluppatore evidenziato a un'icona di un'app creata dallo sviluppatore. Le frecce da e per tornare all'app mostrano il flusso di richiesta e risposta verso un'icona API, con una chiave app posizionata sopra la richiesta. Sotto l'icona dell'API ci sono due insiemi di percorsi delle risorse raggruppati in due prodotti API: Prodotto Location e Prodotto multimediale. Il prodotto Location dispone di risorse per /countries, /cities e /languages, mentre il prodotto Media offre risorse per /books, /magazines e /movies. A destra dell'API sono indicate le risorse di backend chiamate dall'API, tra cui un database, un bus di servizi aziendali, server di app e un backend generico.

In qualità di provider 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 e cognome. Se approvi la richiesta dello sviluppatore, puoi utilizzare la UI di Apigee per registrare manualmente lo sviluppatore. Per saperne di più, consulta la sezione Registrazione degli sviluppatori di app.

Attività 3: registra un'app sviluppatore

Prima di poter accedere alle API, un'app deve essere registrata. Tuttavia, solo uno sviluppatore registrato può registrare un'app.

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 dei tasti API sono evidenziate. Una linea tratteggiata punta dallo sviluppatore all'icona di un'app creata dallo sviluppatore. Le frecce da e per tornare all'app mostrano il flusso di richiesta e risposta verso un'icona API, con una chiave 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 Location e Prodotto multimediale. Il prodotto Location dispone di risorse per /countries, /cities e /languages, mentre il prodotto Media offre risorse per /books, /magazines e /movies. A destra dell'API sono indicate le risorse di backend chiamate dall'API, tra cui un database, un bus di servizi aziendali, server di 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 API corrispondenti a diversi tipi di servizi e piani tariffari. Lo sviluppatore dell'app potrà quindi effettuare una selezione dall'elenco dei prodotti API disponibili.

In risposta alla registrazione dell'app su Apigee, Apigee assegna una chiave API univoca all'app, che deve passare tale chiave API 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 API, puoi decidere in che modo registrare le app. Cosa puoi fare:

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

Per ulteriori informazioni, consulta la sezione Registrazione di app e gestione delle chiavi API.

Attività 4: documenta le tue API

Una considerazione importante per la pubblicazione di prodotti API è la documentazione e un meccanismo di feedback per gli sviluppatori. I portali per sviluppatori con funzionalità di pubblicazione social sono sempre più utilizzati per la comunicazione con la community degli sviluppatori. Ciò include la comunicazione di contenuti statici, come la documentazione delle API e i termini e condizioni d'uso, nonché contenuti dinamici offerti dalla community come blog e forum, nonché funzionalità di assistenza clienti.

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. È evidenziata l'icona sviluppatore. Sotto lo sviluppatore è presente un riquadro che rappresenta un portale per gli sviluppatori. Il portale contiene documentazione, esempi, tutorial, riferimenti API e altro per le API. Il portale contiene anche blog, forum e un portale di assistenza. Una linea tratteggiata punta dallo sviluppatore evidenziato all'icona di un'app creata dallo sviluppatore. Le frecce da e per tornare all'app mostrano il flusso di richiesta e risposta verso un'icona API, con una chiave app posizionata sopra la richiesta. Sotto l'icona dell'API ci sono due insiemi di percorsi delle risorse raggruppati in due prodotti API: Prodotto Location e Prodotto multimediale. Il prodotto Location dispone di risorse per /countries, /cities e /languages, mentre il prodotto Media offre risorse per /books, /magazines e /movies. A destra dell'API sono indicate le risorse di backend chiamate dall'API, tra cui un database, un bus di servizi aziendali, server di app e un backend generico.

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

SmartDocs ti consente di documentare le tue API sul portale Servizi per sviluppatori in modo da rendere la documentazione dell'API completamente interattiva. Grazie alla documentazione interattiva con SmartDocs, gli utenti del portale possono:

  • Informazioni sull'API
  • Invia una richiesta in tempo reale all'API
  • Visualizzare una risposta in tempo reale restituita dall'API

Per saperne di più, consulta le seguenti sezioni: