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 scopo di quota, fatturazione e monitoraggio. R uno sviluppatore genera una chiave API in un progetto nella console Google Cloud incorpora la chiave in ogni chiamata all'API come parametro di query o in un'intestazione della richiesta.

Se specifichi un requisito per la chiave API nella configurazione 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.

Nota: a differenza delle credenziali che utilizzano token di breve durata o richieste firmate, le chiavi API funzionano come parte della richiesta API. Di conseguenza, le chiavi API sono vulnerabili attacchi man in the middle e potrebbe non essere così sicuro come le altre credenziali di autenticazione. Puoi utilizzare le chiavi API insieme a una delle altre forme di autenticazione supportate, ma sconsigliamo di utilizzare solo le chiavi API quando le chiamate API contengono dati sensibili.

Per creare una chiave API o per visualizzare le chiavi API già disponibili nel tuo progetto Google Cloud, vai alla sezione API e Servizi > pagina Credenziali.

Vai a credenziali

Caso d'uso

Per utilizzare funzionalità di API Gateway come quote di spazio, puoi passare in un'API per consentire ad API Gateway di identificare il progetto Google Cloud a cui è associata l'applicazione client.

Informazioni sull'autenticazione della chiave 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 le API che è possibile chiamare usando la chiave API. Tutte le chiavi API utilizzate dalle applicazioni di produzione devono avere restrizioni API.

Per aggiungere limitazioni delle API:

1. Individua il titolo dell'API indicato nella configurazione API. Nell'esempio seguente, 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
   ...

2. Nella console Google Cloud, vai al menu API e Servizi > pagina Credenziali.

   Vai a credenziali

3. Seleziona il nome della chiave API che vuoi utilizzare per la tua API.

4. Nella sezione Restrizioni API della pagina dei dettagli della chiave API, fai clic su Limita chiave.

5. 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.

6. Fai clic su Salva.

La limitazione dovrebbe essere applicata a breve.