Introduzione ai prodotti basati su API

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Le sezioni seguenti introducono i prodotti API e i concetti correlati, come quote e chiavi API.

Che cos'è un prodotto API?

In qualità di provider di API, puoi creare prodotti basati su API per raggruppare le tue API e renderle disponibili per il consumo agli sviluppatori di app. I prodotti basati su API possono essere considerati come una linea di prodotti.

Nello specifico, un prodotto API raggruppa una o più operazioni. Un'operazione specifica un proxy API e i percorsi delle risorse a cui è possibile accedere su quel proxy. Un'operazione può anche limitare l'accesso tramite metodi HTTP e quota.

I prodotti basati su API sono il meccanismo centrale per controllo dell'accesso alle API. Se definisci uno o più prodotti API in un'app per sviluppatori, puoi limitare l'accesso ai proxy con una chiave API. In Apigee, viene eseguito il provisioning delle chiavi API non per le API, ma per i prodotti API. In altre parole, viene eseguito il provisioning delle chiavi API per pacchetti di operazioni che definiscono una linea di prodotti o un piano di servizio specifico.

Casi d'uso comuni

Puoi creare più prodotti API che contengono operazioni per gestire casi d'uso specifici. Ad esempio, puoi creare un prodotto API che raggruppa una serie di operazioni che contengono risorse di mappatura per consentire agli sviluppatori di integrare facilmente le mappe nelle loro applicazioni.

Inoltre, puoi utilizzare i prodotti basati su API per definire i livelli di prezzo in base a criteri quali:

Il numero di richieste:

  • Premium: richieste illimitate al giorno
  • Base: fino a 1000 richieste al giorno
  • Gratuito: fino a 100 richieste al giorno

O livello di accesso:

  • Premium: lettura, scrittura, aggiornamento ed eliminazione
  • Base: lettura e aggiornamento
  • Gratuita: sola lettura

O una qualsiasi combinazione di questi elementi:

  • Premium extra: leggi e scrivi un numero illimitato di volte al giorno
  • Premium: lettura e scrittura fino a 1000 richieste al giorno
  • Base: accesso in lettura e scrittura fino a 100 volte al giorno
  • Gratuito: leggi fino a 1000 volte al giorno
  • Gratuito: accesso di sola lettura limitato a 100 richieste al giorno

Requisiti

I prodotti basati su API che fanno parte del pagamento a consumo devono includere:

Suite operativa

Un'operazione è un gruppo di attributi che limitano l'accesso a uno o più proxy API in base a criteri come percorso della risorsa, metodo HTTP e quota. Un'operazione include i seguenti attributi:

Attributo Obbligatorio? Descrizione
proxy API Obbligatorio Ogni gruppo operazioni deve specificare un proxy API. È consentito un solo proxy per gruppo di operazioni.
Servizio remoto Dipende Necessario solo se installi e prevedi di utilizzare Apigee Adapter for Envoy.
Percorso della risorsa Obbligatorio Ogni gruppo di operazioni deve specificare uno o più percorsi di risorse. I percorsi delle risorse in un'operazione limitano l'accesso a risorse specifiche su un proxy API. (un percorso risorsa è la parte di un URL di richiesta proxy API che segue il percorso di base del proxy).
Metodo HTTP Facoltativo Puoi anche limitare l'accesso a un proxy utilizzando il metodo HTTP. Ad esempio, se specifichi i metodi GET e POST per un gruppo operazioni, solo le richieste HTTP GET e POST possono accedere al proxy per il percorso della risorsa specificato. Se non viene specificato nessun metodo, sono consentiti tutti i metodi.
Quota Facoltativo Puoi specificare una quota per il gruppo di operazioni. La quota specificata in un gruppo operazioni ha la precedenza su una quota a livello di prodotto API, se specificata.
Attributi personalizzati Facoltativo Gli attributi personalizzati sono utili per le metriche, il monitoraggio o i casi in cui vuoi archiviare ulteriori informazioni con un prodotto API a cui è possibile accedere o che puoi recuperare in un secondo momento. Gli attributi personalizzati associati a un'operazione esistono in aggiunta a qualsiasi attributo personalizzato a livello di prodotto API e sono accessibili in runtime come variabili di flusso con il prefisso apiproduct.operation.attributes.

Chiavi API

Quando registri l'app di uno sviluppatore nella tua organizzazione, questa deve essere associata ad almeno un prodotto API. Come risultato dell'accoppiamento di un'app con uno o più prodotti API, Apigee assegna all'app una chiave utente unica. Consulta anche Controllo dell'accesso alle API mediante la registrazione delle app.

La chiave utente o il token di accesso fungono da credenziali di richiesta. Lo sviluppatore di app incorpora la chiave consumer nell'app in modo che quando l'app effettua una richiesta a un'API ospitata da Apigee, l'app passa la chiave consumer nella richiesta in uno dei seguenti modi:

  • Quando l'API utilizza la verifica della chiave API, l'app deve passare direttamente la chiave utente.
  • Quando l'API utilizza la verifica del token OAuth, l'app deve trasmettere un token derivato dalla chiave utente.

L'applicazione delle chiavi API non avviene automaticamente. Sia che utilizzi la chiave utente o i token OAuth come credenziali di richiesta, il proxy API convalida le credenziali di richiesta nei proxy API includendo un criterio VerificationAPIKey o una configurazione di criteri VerifyAccessToken (vedi criterio OAuthv2) nel flusso appropriato. Se non includi un criterio di applicazione delle credenziali nel proxy API, qualsiasi chiamante può richiamare le tue API.

Per verificare le credenziali trasmesse nella richiesta, Apigee esegue questi passaggi:

  1. Recupera le credenziali passate con la richiesta. Nel caso della verifica del token OAuth, Apigee verifica che il token non sia scaduto e quindi cerca la chiave utente utilizzata per generare il token.
  2. Recupera l'elenco dei prodotti API a cui è stata associata la chiave utente.
  3. Conferma che il proxy API corrente sia incluso nel prodotto API, se il percorso della risorsa attuale (percorso URL) è abilitato nel prodotto API e, se incluso nel prodotto, che la richiesta utilizza un verbo HTTP specificato.
  4. Verifica che la quota, se specificata, non sia stata superata.
  5. Verifica che la chiave utente non sia scaduta o revocata, che l'app non sia stata revocata e che lo sviluppatore dell'app sia attivo.

Se tutti i controlli precedenti vengono superati, la verifica delle credenziali ha esito positivo.

In conclusione, Apigee genera automaticamente chiavi consumer, ma gli editori di API devono applicare il controllo delle chiavi nei proxy API utilizzando criteri appropriati.

Approvazione chiave

Per impostazione predefinita, tutte le richieste per ottenere una chiave per accedere a un prodotto API da un'app vengono approvate automaticamente. In alternativa, puoi configurare il prodotto API in modo da dover approvare le chiavi manualmente. L'impostazione è descritta in Gestione dei prodotti API. In questo caso, dovrai approvare le richieste chiave da qualsiasi app che aggiunge il prodotto API. Per maggiori informazioni, consulta Controllo dell'accesso alle API mediante la registrazione delle app.

Quote

Le quote possono proteggere i server di backend da variazioni elevate del traffico e differenziare la tua linea di prodotti. Ad esempio, puoi raggruppare risorse con una quota elevata come prodotto premium e utilizzare lo stesso bundle con una quota inferiore come prodotto di base. Le quote possono aiutare a proteggere i server dal sovraccaricamento se un prodotto è popolare e riceve una grande quantità di richieste in un breve periodo di tempo.

Puoi specificare una quota applicabile a tutti i proxy API inclusi nel prodotto API oppure specificare quote a livello di operazione. Una quota specificata in un'operazione ha la precedenza su una quota impostata a livello di prodotto API.

L'impostazione di limiti di quota in un prodotto API non applica automaticamente la quota. È semplicemente un limite predefinito a cui si può fare riferimento nei criteri per le quote. Ecco alcuni vantaggi dell'impostazione di una quota sul prodotto a cui far riferimento i criteri di quota:

  • Utilizza un criterio per le quote per applicare un'impostazione uniforme a tutti i proxy API in un prodotto API.
  • Se modifichi le impostazioni delle quote del prodotto API in fase di runtime, i criteri per le quote faranno automaticamente riferimento alle impostazioni di quota aggiornate.

Per ulteriori informazioni, consulta le seguenti risorse:

Ambiti OAuth

Puoi definire gli ambiti OAuth come elenchi separati da virgole che devono essere presenti nei token di accesso associati al prodotto. Per ulteriori informazioni sull'utilizzo degli ambiti con i criteri OAuth di Apigee, consulta Utilizzo degli ambiti OAuth2.

Livelli di accesso

Quando si definisce un prodotto API, è possibile impostare i seguenti livelli di accesso:

Livello di accesso Descrizione
Public Prodotti basati su API disponibili per tutti gli sviluppatori. Puoi aggiungerli a portali per sviluppatori integrati o basati su Drupal.
Private o Internal only Prodotti basati su API progettati per l'uso privato o interno.

Per il portale integrato, puoi aggiungere prodotti API Private o Internal only e renderli disponibili agli sviluppatori di app, come richiesto.

Per i portali per sviluppatori basati su Drupal, puoi gestire l'accesso ai prodotti API Private o Internal only sul tuo portale per sviluppatori, come descritto nelle seguenti sezioni:

  • Per i portali per sviluppatori 10 di Drupal, puoi configurare l'accesso ai prodotti API Private o Internal only sul tuo portale per gli sviluppatori, come descritto in Configurare le autorizzazioni di accesso ai prodotti API.

  • Per i portali per gli sviluppatori di Drupal 7, non puoi aggiungere i prodotti API Private o Internal only al tuo portale per gli sviluppatori.

    Per rendere disponibili i prodotti API Private o Internal only agli sviluppatori di app, devi aggiungerli manualmente a un'app registrata dalla UI o dall'API Apigee, come descritto in Controllare l'accesso alle API mediante la registrazione delle app.

    Dopo l'aggiunta, lo sviluppatore vede nel portale il prodotto API associato all'app, come descritto nella sezione Gestire i prodotti API in un'app. Se lo sviluppatore dell'app disattiva l'accesso a un prodotto API di tipo Private o Internal only, il prodotto API viene rimosso dall'app e deve essere aggiunto di nuovo manualmente dall'amministratore del portale.