Definizione dei piani di utilizzo per gestire l'accesso dei sottoscrittori alle API

Scopri come definire i piani d'uso per gestire l'accesso degli abbonati alle API con il gateway API.

Dopo aver creato un gateway API e aver distribuito una o più API su di esso, i responsabili dei piani API in genere desiderano:

  • monitorare e gestire i consumer API e i client API che accedono alle API
  • impostare livelli di accesso diversi per clienti diversi.

I manager dei piani API possono monitorare e gestire l'accesso alle API creando piani di utilizzo e sottoscrittori. Vedere Piani di utilizzo e abilitazioni, sottoscrittori e token client.

È possibile sottoporre l'accesso all'API a limiti di tariffa e quote personalizzati in base a specifiche esigenze dei clienti, consentendo di impostare livelli di accesso diversi per clienti diversi. Ad esempio, potresti voler offrire tre livelli di accesso alle tue API: un livello Gold, che consente fino a 1000 richieste all'ora, un livello Silver, che consente fino a 500 richieste all'ora e un livello Bronzo, che consente fino a 100 richieste all'ora. È inoltre possibile imporre un limite di frequenza generale di 10 richieste al secondo per ogni cliente, per garantire che l'uso intensivo da parte di un cliente non influisca sugli altri clienti.

Per impostare un piano di utilizzo e un sottoscrittore per gestire l'accesso a un'API, è necessario:

  • Rendere una distribuzione API idonea per l'inclusione in un piano di utilizzo.

    Per rendere una distribuzione API idonea per l'inclusione in un piano di utilizzo, è necessario specificare la posizione di un token client passato in una richiesta. Una volta inclusa la distribuzione API in un piano di utilizzo, le richieste dei client API sottoscritti devono includere il token client in questa posizione per accedere alla distribuzione API. Specificare la posizione del token client in un criterio di richiesta del piano di utilizzo globale per tutti gli instradamenti in una specifica di distribuzione API. Vedere Come rendere idonea una distribuzione API per l'inclusione in un piano di utilizzo.

  • Creare un piano di utilizzo con un'abilitazione che specifichi la distribuzione API come destinazione.

    Dopo aver reso la distribuzione API idonea per l'inclusione, è possibile creare una definizione di piano di utilizzo che includa un'abilitazione che specifica la distribuzione API come destinazione e, facoltativamente, specifica un limite di frequenza e una quota. Se il numero di richieste in un determinato periodo di tempo supera una quota di richieste, è possibile specificare se le richieste continuano ad essere consentite o rifiutate. Se una richiesta viene rifiutata perché la quota è stata superata, l'intestazione della risposta indica quando è possibile rieseguire la richiesta. Vedere Creazione di un piano di utilizzo.

  • Creare una definizione di sottoscrittore che specifichi il piano di utilizzo.

    Dopo aver creato un piano di utilizzo, è possibile creare una o più definizioni di sottoscrittori per i clienti (clienti API) e i relativi client API. Una definizione di sottoscrittore include i nomi client e i token client per identificare in modo univoco i client API e specifica il piano di utilizzo che consente loro di accedere alle API. Vedere Creazione di un sottoscrittore.

Dopo aver impostato un piano di utilizzo, è possibile utilizzare le metriche per comprendere i pattern di utilizzo e inviare messaggi di allarme quando i limiti di frequenza e le quote vengono raggiunti e superati. Vedere Metriche del gateway API.