Utilizzo di chiavi API

In questa pagina viene descritto come utilizzare le chiavi API in API Gateway.

Una chiave API è una stringa semplice 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 all'API come parametro di query o nell'intestazione di una 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 progetto Google Cloud o all'interno di altri progetti Google Cloud in cui l'API è stata abilitata.

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 agli attacchi man in the middle e potrebbero non essere sicure quanto altre credenziali di autenticazione. Puoi utilizzare le chiavi API in aggiunta 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 visualizzare le chiavi API già disponibili nel tuo progetto Google Cloud, vai alla pagina API e servizi > Credenziali.

Vai a Credenziali

Caso d'uso

Per utilizzare le funzionalità di API Gateway, ad esempio le quotas, 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 della chiave API per API Gateway

Se utilizzi una chiave API per l'autenticazione, devi prima abilitare 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 al momento del deployment dell'API. Puoi trovare questo nome nella colonna Managed Service (Servizio gestito) della 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 limitate per impostazione predefinita. Le chiavi senza restrizioni non sono sicure perché possono essere utilizzate da chiunque, ovunque. Ti consigliamo di aggiungere restrizioni delle API, se possibile. Le restrizioni delle API specificano le API che è possibile chiamare utilizzando la chiave API. Tutte le chiavi API utilizzate dalle applicazioni di produzione devono avere limitazioni API.

Per aggiungere restrizioni delle API:

1. Trova il titolo dell'API come indicato nella relativa configurazione. 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 alla pagina API e servizi > Credenziali.

   Vai a Credenziali

3. Seleziona il nome della chiave API che vuoi utilizzare per l'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 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.