Piani di utilizzo e API chiavi per REST APIs in API Gateway

Dopo aver creato, testato e distribuito i tuoiAPIs, puoi utilizzare i piani di utilizzo di API Gateway per renderli disponibili come offerte di prodotti per i tuoi clienti. Puoi configurare piani e API chiavi di utilizzo per consentire ai clienti di accedere a determinati APIs piani di utilizzo e iniziare a limitare le richieste a quelle APIs basate su limiti e quote definiti. Queste possono essere impostate a livello di o API API metodo.

Cosa sono i piani e API le chiavi di utilizzo?

Un piano di utilizzo specifica chi può accedere a una o più API fasi e metodi implementati e, facoltativamente, imposta la frequenza di richieste target per iniziare a limitare le richieste. Il piano utilizza API le chiavi per identificare API i clienti e chi può accedere alle fasi associate a ciascuna chiave. API

APIle chiavi sono valori di stringhe alfanumeriche che distribuisci ai clienti sviluppatori di applicazioni per concedere l'accesso ai tuoi. API Puoi utilizzare API le chiavi insieme agli autorizzatori Lambda, ai IAMruoli o ad Amazon Cognito per controllare l'accesso al tuo. APIs APIGateway può generare API chiavi per tuo conto oppure puoi importarle da un file. CSV È possibile generare una API chiave in API Gateway o importarla in API Gateway da una fonte esterna. Per ulteriori informazioni, consulta Configura API le chiavi utilizzando la console Gateway API.

Una API chiave ha un nome e un valore. (I termini «APIchiave» e "valore API chiave» sono spesso usati in modo intercambiabile.) Il nome non può superare 1024 caratteri. Il valore è una stringa alfanumerica tra 20 e 128 caratteri, ad esempio, apikey1234abcdefghij0123456789.

Importante

APIi valori chiave devono essere unici. Se si tenta di creare due API chiavi con nomi diversi e lo stesso valore, API Gateway le considera come la stessa API chiave.

Una API chiave può essere associata a più di un piano di utilizzo. Un piano di utilizzo può essere associato a più fasi. Tuttavia, una determinata API chiave può essere associata a un solo piano di utilizzo per ogni fase del tuoAPI.

Un limite di throttling imposta il punto di destinazione in cui dovrebbe iniziare la limitazione delle richieste. Questo può essere impostato a livello di API metodo API o.

Un limite di quota imposta il numero massimo previsto di richieste con una determinata API chiave che possono essere inviate entro un intervallo di tempo specificato. È possibile configurare API metodi individuali per richiedere l'autorizzazione delle API chiavi in base alla configurazione del piano di utilizzo.

I limiti di limitazione e di quota si applicano alle richieste di API chiavi individuali che vengono aggregate in tutte le API fasi di un piano di utilizzo.

Nota

I piani di utilizzo della limitazione (della larghezza di banda della rete) e le quote non sono limiti rigidi e vengono applicati sulla base del miglior tentativo. In alcuni casi, i client possono superare le quote impostate. Non fare affidamento sulle quote del piano di utilizzo o sulla limitazione per controllare i costi o bloccare l'accesso a un. API Prendi in considerazione l'utilizzo Budget AWSper monitorare i costi e AWS WAFgestire le richieste. API

Le migliori pratiche per API chiavi e piani di utilizzo

Di seguito sono riportate le best practice suggerite da seguire per l'utilizzo di API chiavi e piani di utilizzo.

Importante

• Non utilizzare API chiavi per l'autenticazione o l'autorizzazione per controllare l'accesso al tuoAPIs. Se ne hai più di uno APIs in un piano di utilizzo, un utente con una API chiave valida per una di esse API in quel piano di utilizzo può accedere APIs a tutte le chiavi incluse in quel piano di utilizzo. Invece, per controllare l'accesso al tuoAPI, usa un IAM ruolo, un autorizzatore Lambda o un pool di utenti Amazon Cognito.

• Usa API le chiavi generate da GatewayAPI. APIle chiavi non devono includere informazioni riservate; i client in genere le trasmettono in intestazioni che possono essere registrate.

• Se utilizzi un portale per sviluppatori per pubblicare i tuoiAPIs, tieni presente che tutti i tuoi contenuti APIs inclusi in un determinato piano di utilizzo possono essere sottoscritti dai clienti, anche se non li hai resi visibili ai tuoi clienti.

• In alcuni casi, i client possono superare le quote impostate. Non fare affidamento sui piani di utilizzo per controllare i costi. Valuta la possibilità Budget AWSdi utilizzarlo per monitorare i costi e AWS WAFgestire le API richieste.

• Dopo aver aggiunto una API chiave a un piano di utilizzo, il completamento dell'operazione di aggiornamento potrebbe richiedere alcuni minuti.