Panoramica della pubblicazione

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

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

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

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 Risorse API offerte come pacchetto agli sviluppatori di app per il consumo. Crea API usando l'API o la UI di Apigee. (Consulta Che cos'è un prodotto API? per saperne di più sulle API products.)

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, le API e servizi di backend. L'icona dell'API e le risorse sono evidenziate. Una linea tratteggiata i punti dello sviluppatore a un'icona di un'app creata dallo sviluppatore. Frecce da e Torna all'app e mostra il flusso di richiesta e risposta a un'icona API, con una chiave app posizionata al di sopra della richiesta. L'icona dell'API e le risorse sono evidenziate. Sotto l'icona dell'API ci sono due set di percorsi di risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Location dispone di risorse per /countries, /cities e /languages, nonché per i media Il prodotto dispone di risorse per /books, /magazines e /movies. A destra dell'API sono presenti risorse di backend chiamate dall'API, tra cui un database, un bus di servizi aziendali, 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 controllo dell'accesso, restrizioni all'uso e qualsiasi altro requisito aziendale. Ad esempio, potrebbe:

  • 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 alla stessa API risorse come la 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 permetta l'accesso in lettura/scrittura allo stesso risorsa API, ma con un limite di accesso elevato.

La cosa importante da ricordare è che Apigee vi offre la flessibilità per creare prodotti API che soddisfano i requisiti aziendali delle tue 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 propria app. Quando registrano l'app, ricevono una chiave API che concederà all'app l'accesso all'API.

Tramite la procedura di registrazione dell'app, puoi controllare chi può accedere alle tue API. In qualsiasi momento, puoi eliminare uno sviluppatore di app, annullando così tutte le chiavi API associate a quello sviluppatore, negando quindi l'accesso alle tue API da parte dello sviluppatore.

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, le API e servizi di backend. È evidenziata l'icona sviluppatore. Una linea tratteggiata punta dal lo sviluppatore ha evidenziato l'icona di un'app creata dallo sviluppatore. Frecce da e Torna all'app e mostra il flusso di richiesta e risposta a un'icona API, con una chiave app posizionata al di sopra della richiesta. Sotto l'icona dell'API ci sono due set di percorsi di risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Location dispone di risorse per /countries, /cities e /languages, nonché per i media Il prodotto dispone di risorse per /books, /magazines e /movies. A destra dell'API sono presenti risorse di backend chiamate dall'API, tra cui un database, un bus di servizi aziendali, 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 che richiede che un potenziale sviluppatore contatti la tua organizzazione per registro. Il potenziale sviluppatore deve fornire tutte le informazioni necessarie, ad esempio un'email indirizzo, nome e cognome. Se approvi la richiesta dello sviluppatore, può utilizzare la UI di Apigee per registrare manualmente lo sviluppatore. Consulta l'articolo Registrazione di sviluppatori di app per altro ancora.

Attività 3: registra un'app sviluppatore

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

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, le API e servizi di backend. Le frecce dell'app, della richiesta/risposta e dei tasti API sono evidenziate. A punteggiato i punti linea dallo sviluppatore all'icona di un'app creata dallo sviluppatore. Frecce da e Torna all'app e mostra il flusso di richiesta e risposta a un'icona API, con una chiave app posizionata al di sopra della richiesta. L'icona dell'API e le risorse sono evidenziate. Sotto l'icona dell'API ci sono due set di percorsi di risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Location dispone di risorse per /countries, /cities e /languages, nonché per i media Il prodotto dispone di risorse per /books, /magazines e /movies. A destra dell'API sono presenti risorse di backend chiamate dall'API, tra cui un database, un bus di servizi aziendali, 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 prezzi piani. Lo sviluppatore dell'app può quindi scegliere dall'elenco di prodotti API disponibili.

In risposta alla registrazione dell'app su Apigee, Apigee assegna una chiave API univoca all'app. L'app deve passare tale chiave API come parte di ogni richiesta a una risorsa API. La chiave viene autenticata e se valida, la richiesta viene accolta. In qualità di fornitore di servizi, puoi revocare la chiave in qualsiasi momento che l'app non possa più accedere alle tue API.

In qualità di provider API, puoi decidere in che modo 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, dovresti inviare allo sviluppatore la chiave API, possibilmente email.
  • Usa l'API Apigee per integrare la funzionalità di registrazione delle app e la consegna delle chiavi sul tuo sito web.
  • Per un account Apigee a pagamento, usa il portale Apigee Developer Services, che include supporto per la registrazione delle app e la consegna delle chiavi API.

Per ulteriori informazioni, consulta la sezione Registrazione di app e gestione dell'API. chiave.

Attività 4: documenta le tue API

Una considerazione importante per la pubblicazione di prodotti API è la documentazione e un meccanismo di feedback degli sviluppatori. I portali per sviluppatori con funzioni di pubblicazione social sono sempre più per le comunicazioni con la comunità di sviluppatori. Ciò include comunicazioni statiche contenuti, come la documentazione dell'API e i Termini e condizioni d'uso, nonché contenuti dinamici contenuti come blog e forum, nonché funzioni di assistenza clienti.

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

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

SmartDocs ti consente di documentare le tue API sul portale Servizi per sviluppatori in un che rende la documentazione dell'API completamente interattiva. Documentazione interattiva con SmartDocs significa che 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: