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 tue API disponibili per l'utilizzo da parte degli sviluppatori di app.

Video:il seguente video fornisce un'introduzione generale alla pubblicazione di 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. Registra le app per sviluppatori.
  4. Fornisci documentazione e assistenza della community per le tue API.

Attività 1: crea un prodotto API

La prima attività di pubblicazione consiste nel 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 l'interfaccia utente Apigee. Per scoprire di più sui prodotti API, consulta la sezione 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 collega lo sviluppatore a un'icona di un'app creata dallo sviluppatore. Le frecce che vanno dall'app all'icona dell'API e viceversa mostrano il flusso di richiesta e risposta, con una chiave dell'app posizionata sopra la richiesta. L'icona e le risorse dell'API sono evidenziate. Sotto l'icona dell'API si trovano due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località ha risorse per /countries, /cities e /languages, mentre il prodotto Media ha risorse per /books, /magazines e /movies. A destra dell'API si trovano le risorse di backend che l'API chiama, tra cui un database, un bus di servizio aziendale, server di app e un backend generico.

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

  • Rilascia un prodotto API gratuito che consenta 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 ti offre la flessibilità di creare prodotti API che soddisfano i requisiti aziendali delle tue API.

Per saperne di più 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 registra l'app, riceve una chiave API che darà all'app l'accesso all'API.

Tramite il processo di registrazione delle app, controlli chi ha accesso alle tue API. In qualsiasi momento, puoi eliminare uno sviluppatore di app, il che invalida tutte le chiavi API associate a questo sviluppatore, negandogli quindi 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 punta dallo sviluppatore evidenziato a un'icona di un'app creata dallo sviluppatore. Le frecce che vanno dall'app all'icona dell'API e viceversa mostrano il flusso di richiesta e risposta, con una chiave dell'app posizionata sopra la richiesta. Sotto l'icona dell'API si trovano due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località ha risorse per /countries, /cities e /languages, mentre il prodotto Media ha risorse per /books, /magazines e /movies. A destra dell'API si trovano le risorse di backend che l'API chiama, tra cui un database, un bus di servizio aziendale, server di app e un backend generico.

In qualità di fornitore di API, decidi 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, puoi utilizzare l'interfaccia utente Apigee per registrarlo manualmente. Per saperne di più, consulta la sezione Registrazione degli sviluppatori di app.

Attività 3: registra un'app per sviluppatori

Prima che un'app possa accedere alle tue API, 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 della chiave API sono evidenziate. Una linea tratteggiata punta dallo sviluppatore a un'icona di un'app creata dallo sviluppatore. Le frecce che vanno dall'app all'icona dell'API e viceversa mostrano il flusso di richiesta e risposta, con una chiave dell'app posizionata sopra la richiesta. L'icona e le risorse dell'API sono evidenziate. Sotto l'icona dell'API si trovano due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località ha risorse per /countries, /cities e /languages, mentre il prodotto Media ha risorse per /books, /magazines e /movies. A destra dell'API si trovano le risorse di backend che l'API chiama, 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 tariffari. Lo sviluppatore di 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 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, decidi come registrare le app. Potresti:

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

Per saperne di più, consulta Registrazione delle app e gestione delle chiavi API.

Attività 4: documenta le tue API

Un aspetto importante da considerare per la pubblicazione dei prodotti API è la fornitura di documentazione e di un meccanismo di feedback per gli sviluppatori. I portali per sviluppatori con funzionalità di pubblicazione sui social vengono utilizzati sempre più spesso per la comunicazione con la community di sviluppo. Ciò include la comunicazione di contenuti statici, come la documentazione API e i termini di utilizzo, nonché contenuti dinamici forniti dalla community, come blog e forum, e 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 c'è una casella che rappresenta un portale per sviluppatori. Il portale contiene documentazione, esempi, tutorial, riferimenti e altro ancora per le API. Il portale contiene anche blog, forum e un portale di assistenza. Una linea punteggiata punta dallo sviluppatore evidenziato a un'icona di un'app creata dallo sviluppatore. Le frecce che vanno e tornano dall'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 si trovano due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località ha risorse per /countries, /cities e /languages, mentre il prodotto Media ha risorse per /books, /magazines e /movies. A destra dell'API si trovano le risorse di backend che l'API chiama, tra cui un database, un bus di servizio aziendale, server di 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 Apigee Developer Services. Il portale offre supporto integrato per documentazione, blog, forum e altri tipi di contenuti necessari per supportare la tua community di sviluppatori.

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

  • Scopri di più sull'API
  • Inviare una richiesta live all'API
  • Visualizzare una risposta in tempo reale restituita dall'API

Per saperne di più, consulta le sezioni seguenti: