Panoramica della pubblicazione

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

La pubblicazione è il processo di rendere le API disponibili agli sviluppatori di app per il consumo.

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 i prodotti API che raggruppano le tue API.
  2. Registra gli sviluppatori di app.
  3. Consente di registrare le app degli sviluppatori.
  4. Fornisci la documentazione e l'assistenza dalla community per le tue API.

Attività 1: crea un prodotto API

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

Un diagramma sequenza da sinistra a destra che mostra uno sviluppatore, un'app, le API e i servizi di backend. L'icona dell'API e le risorse sono evidenziate. Una linea tratteggiata rimanda dallo sviluppatore all'icona di un'app creata da quest'ultimo. Le frecce che collegano l'app e viceversa 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 sono presenti due insiemi di percorsi delle risorse raggruppati in due prodotti API: Prodotto località e Prodotto multimediale. Il prodotto Posizione contiene risorse per /countries, /cities e /languages, mentre il prodotto Media include risorse per /books, /magazines e /movies. A destra dell'API sono presenti le risorse di backend che l'API sta chiamando, tra cui un database, un bus di servizio aziendale, i server delle app e un backend generico.

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 il controllo dell'accesso#39;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 basso 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 più elevato che consenta l'accesso in lettura/scrittura alla stessa risorsa API ma con un limite di accesso elevato.

La cosa importante da ricordare è che Apigee offre la flessibilità di creare prodotti API che soddisfano i requisiti aziendali delle tue API.

Per ulteriori informazioni sulla creazione di prodotti API, consulta Gestione dei prodotti basati su 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. Al momento della registrazione dell'app, riceve una chiave API che le consentirà di accedere all'API.

Tramite il processo di registrazione dell'app, puoi controllare chi può accedere alle tue API. Puoi eliminare uno sviluppatore di app in qualsiasi momento, annullando la validità di tutte le chiavi API associate allo sviluppatore, negando così l'accesso alle tue API.

Un diagramma sequenza da sinistra a destra che mostra uno sviluppatore, un'app, le API e i servizi di backend. L'icona sviluppatore è evidenziata. Una linea tratteggiata rimanda dallo sviluppatore evidenziato all'icona di un'app creata dallo sviluppatore. Le frecce che collegano l'app e viceversa 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 sono presenti due insiemi di percorsi delle risorse raggruppati in due prodotti API: Prodotto località e Prodotto multimediale. Il prodotto Posizione contiene risorse per /countries, /cities e /languages, mentre il prodotto Media include risorse per /books, /magazines e /movies. A destra dell'API sono presenti le risorse di backend che l'API sta chiamando, 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 e cognome. Se approvi la richiesta dello sviluppatore, puoi utilizzare l'interfaccia utente di Apigee per registrare manualmente lo sviluppatore. Per saperne di più, consulta Registrazione degli sviluppatori di app.

Attività 3: registra un'app sviluppatore

Prima che un'app possa accedere alle API, è necessario che sia stata registrata. Tuttavia, solo uno sviluppatore registrato può registrare un'app.

Un diagramma sequenza da sinistra a destra che mostra uno sviluppatore, un'app, le API e i servizi di backend. Le frecce dell'app, della richiesta/risposta e della chiave API sono evidenziate. Una linea tratteggiata rimanda dallo sviluppatore all'icona di un'app creata dallo sviluppatore. Le frecce che collegano l'app e viceversa 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 sono presenti due insiemi di percorsi delle risorse raggruppati in due prodotti API: Prodotto località e Prodotto multimediale. Il prodotto Posizione contiene risorse per /countries, /cities e /languages, mentre il prodotto Media include risorse per /books, /magazines e /movies. A destra dell'API sono presenti le risorse di backend che l'API sta chiamando, 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 API. Ad esempio, puoi pubblicare più prodotti 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 Apigee, Apigee assegna una chiave API univoca all'app. L'app deve passare questa chiave API come parte di ogni richiesta a una risorsa API. La chiave è autenticata e, se valida, la richiesta viene concessa. In qualità di fornitore di servizi, puoi revocare la chiave in qualsiasi momento in modo che l'app non possa più accedere alle tue API.

In qualità di provider di API, sei tu a decidere la modalità di registrazione delle app. Cosa puoi fare:

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

Per maggiori informazioni, consulta Registrazione di app e gestione delle chiavi API.

Attività 4: documenta le tue API

Una considerazione importante per la pubblicazione di prodotti API è fornire la documentazione e 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 sviluppo. Ciò include la comunicazione di contenuti statici, come la documentazione e i Termini e condizioni d'uso delle API, nonché contenuti dinamici forniti dalla community come blog e forum, nonché funzionalità di assistenza clienti.

Un diagramma sequenza da sinistra a destra che mostra uno sviluppatore, un'app, le API e i servizi di backend. L'icona sviluppatore è evidenziata. Sotto lo sviluppatore è presente 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 rimanda dallo sviluppatore evidenziato all'icona di un'app creata dallo sviluppatore. Le frecce che collegano l'app e viceversa 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 sono presenti due insiemi di percorsi delle risorse raggruppati in due prodotti API: Prodotto località e Prodotto multimediale. Il prodotto Posizione contiene risorse per /countries, /cities e /languages, mentre il prodotto Media include risorse per /books, /magazines e /movies. A destra dell'API sono presenti le risorse di backend che l'API sta chiamando, 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 Apigee a pagamento, puoi utilizzare il portale dei servizi per sviluppatori Apigee. Il portale offre supporto integrato per documentazione, blog, forum e altri tipi di contenuti necessari per supportare la community di sviluppatori.

SmartDocs consente di documentare le API sul portale di Developer Services in modo da rendere la documentazione delle 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
  • Visualizza una risposta in tempo reale restituita dall'API

Per saperne di più, consulta le seguenti sezioni: