Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Dopo aver creato, testato e distribuito i tuoi APIs, puoi utilizzare i piani di utilizzo di API Gateway per renderli disponibili come offerte di prodotti per i tuoi clienti. Puoi configurare piani di utilizzo e chiavi API 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. Questi possono essere impostati a livello API o metodo API.
Cosa sono i piani di utilizzo e le chiavi API?
Un piano di utilizzo consente di specificare chi può accedere a una o più fasi e metodi API distribuiti, inclusa la frequenza di richiesta di destinazione per iniziare a limitare le richieste. Il piano utilizza chiavi API per identificare client API e chi può accedere akke fasi API associate a ciascuna chiave.
Le chiavi API sono valori stringa alfanumerici che vengono distribuiti ai clienti degli sviluppatori di applicazioni per concedere l'accesso all'API. Puoi utilizzare le chiavi API insieme agli autorizzatori Lambda, ai ruoli IAM o Amazon Cognito per controllare l'accesso al tuo. APIs API Gateway può generare chiavi API per tuo conto o puoi importarle da un file CSV. Puoi generare una chiave API in API Gateway o importarla in API Gateway da un'origine esterna. Per ulteriori informazioni, consulta Impostare le chiavi API utilizzando la console API Gateway.
Una chiave API ha un nome e un valore. I termini "chiave API" e "valore di chiave API" vengono 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
I valori di chiave API devono essere univoci. Se provi a creare due chiavi API con nomi diversi e lo stesso valore, queste vengono considerate da API Gateway la stessa chiave API.
Una chiave API può essere associata a più piani di utilizzo. Un piano di utilizzo può essere associato a più fasi. Tuttavia, una determinata chiave API può essere associata a un solo piano di utilizzo per ogni fase dell'API.
Un limite di throttling imposta il punto di destinazione in cui dovrebbe iniziare la limitazione delle richieste. Può essere impostato a livello API o metodo API.
Un limite di quota è il numero massimo di richieste con una determinata chiave API che possono essere inviate in un intervallo di tempo specificato. Puoi configurare singoli metodi API per richiedere l'autorizzazione per le chiavi API in base alla configurazione del piano di utilizzo.
I limiti di throttling e di quote si applicano alle richieste per le singole chiavi API che vengono aggregate nelle fasi API in 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 limitazione (della larghezza di banda della rete) per controllare i costi o bloccare l'accesso a un'API. Considerare l’utilizzo di Budget AWS per monitorare i costi e AWS WAF gestire le richieste API.
Passaggi per configurare un piano di utilizzo e le chiavi API in Gateway API
Le seguenti attività descrivono i passaggi necessari per configurare un piano di utilizzo e le chiavi API. Per le best practice, consulta Best practice per le chiavi API e i piani di utilizzo.
Per configurare un piano di utilizzo e le chiavi API
-
Crea un'API e configura la richiesta per ogni metodo API al fine di richiedere una chiave API. Quindi, implementa l'API in una fase.
Per includere i metodi API in un piano di utilizzo, devi configurarli singolarmente in modo che richiedano una chiave API.
Per ulteriori informazioni su come configurare un metodo per richiedere una chiave API, consulta Richiesta di una chiave API per un metodo.
-
Genera o importa chiavi API da distribuire agli sviluppatori di applicazioni (i clienti) che utilizzeranno la tua API. Le chiavi API sono necessarie per il piano di utilizzo.
Per ulteriori informazioni su come generare o importare le chiavi API, consulta Creazione di una chiave API.
-
Crea il piano di utilizzo con i limiti di quota e di limitazione (della larghezza di banda della rete) desiderati, quindi associa le fasi API e le chiavi API al piano di utilizzo.
Per ulteriori informazioni su come creare il piano di utilizzo, consulta Creazione di un piano di utilizzo.
Gli intermediari dell'API devono fornire una chiave API assegnata nell'intestazione x-api-key nelle richieste all'API.
Per un AWS CloudFormation modello completo che crea e associa un piano di utilizzo a una nuova fase e una chiave API, consulta. Crea e configura chiavi API e piani di utilizzo con AWS CloudFormation
Best practice per le chiavi API e i piani di utilizzo
Di seguito vengono fornite le best practice da seguire quando usi chiavi API e piani di utilizzo.
Importante
-
Non utilizzare chiavi API per l'autenticazione o l'autorizzazione per controllare l'accesso al tuo APIs. Se ne hai più APIs in un piano di utilizzo, un utente con una chiave API valida per un'API in quel piano di utilizzo può accedere APIs a tutte le API di quel piano di utilizzo. Per controllare gli accessi all'API, utilizza invece un ruolo IAM, un sistema di autorizzazione Lambda o un pool di utenti di Amazon Cognito.
-
Utilizzare le chiavi API generate da API Gateway. Le chiavi API 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 tuoi APIs, tieni presente che tutti i tuoi contenuti APIs 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. Considera l'utilizzo di Budget AWS per monitorare i costi e di AWS WAF per gestire le richieste API.
-
Dopo aver aggiunto una chiave API a un piano di utilizzo, il completamento dell'operazione di aggiornamento potrebbe richiedere alcuni minuti.
