Utilizzo di chiavi API
Questa pagina descrive come utilizzare le chiavi API in API Gateway.
Una chiave API è una semplice stringa che identifica un progetto Google Cloud a fini di quota, fatturazione e monitoraggio. Uno sviluppatore genera una chiave API in un progetto nella console Google Cloud e la incorpora in ogni chiamata alla tua API come parametro di query o in un'intestazione della richiesta.
Se specifichi un requisito della chiave API nella configurazione dell'API, API Gateway utilizza la chiave API per cercare il progetto Google Cloud associato. API Gateway rifiuta le richieste, a meno che la chiave API non sia stata generata nel tuo progetto Google Cloud o in altri progetti Google Cloud in cui è stata attivata l'API.
Per creare una chiave API o visualizzare le chiavi API già disponibili nel tuo progetto Google Cloud, vai alla pagina API e servizi > Credenziali.
Caso d'uso
Per utilizzare le funzionalità di API Gateway, come le quote, puoi passare una chiave API in modo che API Gateway possa identificare il progetto Google Cloud a cui è associata l'applicazione client.
Informazioni sull'autenticazione delle chiavi API per API Gateway
Se utilizzi una chiave API per l'autenticazione, devi prima attivare il supporto delle chiavi API per il tuo servizio.
Inserisci questo comando:
gcloud services enable MANAGED_SERVICE_NAME
MANAGED_SERVICE_NAME specifica il nome del servizio gestito creato durante il deployment dell'API. Puoi trovare questo nome nella colonna Servizio gestito per la tua API nella pagina di destinazione delle API nella console. In alternativa, puoi trovare questo nome nella proprietà Managed service quando utilizzi il comando gcloud api-gateway apis describe.
Ad esempio:
gcloud services enable my-api-a12bcd345e67f89g0h.apigateway.my-project.cloud.goog
Limitazione delle chiavi API
Le chiavi API non sono soggette a restrizioni per impostazione predefinita. Le chiavi senza restrizioni non sono sicure perché possono essere utilizzate da chiunque, ovunque si trovi. Ti consigliamo di aggiungere limitazioni API, se possibile. Le restrizioni delle API specificano quali API possono essere chiamate utilizzando la chiave API. Tutte le chiavi API utilizzate dalle applicazioni di produzione devono avere restrizioni API.
Per aggiungere limitazioni dell'API:
Trova il titolo dell'API indicato nella configurazione API. Nel seguente esempio, il titolo dell'API è
My Example Config:# openapi.yaml swagger: '2.0' info: title: My Example Config description: Sample API on API Gateway version: 1.0.0 ...
Nella console Google Cloud, vai alla pagina API e servizi > Credenziali.
Seleziona il nome della chiave API che vuoi utilizzare per la tua API.
Nella sezione Restrizioni delle API della pagina dei dettagli della chiave API, fai clic su Limita chiave.
Seleziona l'API a cui verrà utilizzata la chiave API per accedere dall'elenco a discesa delle API disponibili. Ad esempio, se utilizzi la configurazione di esempio riportata sopra, seleziona
My Example Config.Fai clic su Salva.
La limitazione dovrebbe essere applicata a breve.