Se imposti un requisito della chiave API nell'API, vengono richieste al metodo protetto, o API vengono rifiutate a meno che non abbiano una chiave generata nel progetto o all'interno di altri progetti appartenenti agli sviluppatori con cui concesso l'accesso per abilitare la tua API. La il progetto in cui è stata creata la chiave API non viene registrato e non viene aggiunto al l'intestazione della richiesta. Tuttavia, puoi visualizzare il progetto Google Cloud a cui è associato un cliente nella pagina Servizi endpoint, come descritto in Filtrare per un progetto consumer specifico.
Per informazioni sul progetto Google Cloud in cui deve essere creata una chiave API, consulta Condividere le API protette da una chiave API.
Limitare l'accesso a tutti i metodi dell'API
Per richiedere una chiave API per tutte le chiamate all'API, aggiungiapiKeyRequired = AnnotationBoolean.TRUE all'annotazione @Api.
Ad esempio:
@Api(
name = "echo",
version = "v1",
apiKeyRequired = AnnotationBoolean.TRUE
)
public class Echo {
//API class and methods...
}
Limitazione dell'accesso a metodi API specifici
Per richiedere una chiave API per tutte le chiamate a un metodo API specifico, aggiungi
apiKeyRequired = AnnotationBoolean.TRUE al tuo
Annotazione@ApiMethod.
Ad esempio:
Per richiedere una chiave API per tutte le chiamate a un determinato tipo di classe API, aggiungi apiKeyRequired = AnnotationBoolean.TRUE all'annotazione @ApiClass.
Rimozione della limitazione della chiave API per un metodo
Per disattivare la convalida della chiave API per un'API o un metodo dell'API, rimuovi api_key_required=True (Python) o apiKeyRequired = AnnotationBoolean.TRUE (Java) dall'annotazione o dal decoratore dell'API o del metodo. Quindi, ricompila e reimplementa.
Chiamare un'API utilizzando una chiave API
Se un'API o un metodo dell'API richiede una chiave API, forniscila utilizzando un parametro di query denominato key, come mostrato in questo esempio di cURL:
curl \
-H "Content-Type: application/json" \
-X POST \
-d '{"message": "echo"}' \
"${HOST}/_ah/api/echo/v1/echo_api_key?key=${API_KEY}"
dove HOST e API_KEY sono variabili contenenti rispettivamente il nome dell'host API e la chiave API. Sostituisci echo con il nome dell'API e
v1 con la versione dell'API.
Condivisione delle API protette dalla chiave API
Le chiavi API sono associate al progetto Google Cloud in cui sono state create. Se hai deciso di richiedere una chiave API per la tua API, il progetto Google Cloud in cui viene creata la chiave API dipende dalle risposte alle seguenti domande:
- Devi distinguere tra i chiamanti della tua API per poter utilizzare le funzionalità di Endpoints, come le quote?
- Tutti gli utenti che chiamano la tua API hanno i propri progetti Google Cloud?
- Devi impostare diverse limitazioni per le chiavi API?
Puoi utilizzare il seguente albero decisionale come guida per decidere quale Google Cloud progetto in cui creare la chiave API.
Concedi l'autorizzazione per abilitare l'API
Quando devi distinguere tra gli utenti che chiamano la tua API e ogni utente chiamante ha il proprio progetto Google Cloud, puoi concedere ai principali l'autorizzazione per attivare l'API nel proprio progetto Google Cloud. In questo modo, gli utenti della tua API possono creare la propria chiave API utilizzare con l'API.
Ad esempio, supponiamo che il tuo team abbia creato un'API per l'utilizzo interno da parte di vari programmi client della tua azienda e che ogni programma client abbia il proprio progetto Google Cloud. Per distinguere i chiamanti della tua API, la chiave API per ogni chiamante deve essere creata in un progetto Google Cloud diverso. Puoi concedere ai tuoi colleghi l'autorizzazione per abilitare l'API nel progetto Google Cloud a cui è associato il programma client associati.
Per consentire agli utenti di creare la propria chiave API:
- Nel progetto Google Cloud in cui è configurata l'API, concedi a ogni utente l'autorizzazione per attivare l'API.
- Contatta gli utenti e informalo che possono abilitare l'API nel proprio Google Cloud progetto e creare una chiave API.
Creare un progetto Google Cloud separato per ogni chiamante
Quando devi distinguere tra i chiamanti della tua API e non tutti hanno progetti Google Cloud, puoi creare un progetto Google Cloud separato Chiave API per ogni chiamante. Prima di creare i progetti, valuta attentamente i nomi in modo da poter identificare facilmente il chiamante associato al progetto.
Ad esempio, supponiamo che tu abbia clienti esterni della tua API e non abbiamo idea di come siano stati creati i programmi client che chiamano la tua API. Forse alcuni dei clienti utilizzano i servizi Google Cloud e hanno un progetto Google Cloud, mentre altri no. Per distinguere i chiamanti, devi creare un progetto Google Cloud e una chiave API distinti per ogni chiamante.
Per creare un progetto Google Cloud e una chiave API distinti per ogni chiamante:
- Crea un progetto separato per ogni chiamante.
- In ogni progetto, abilita l'API e creare una chiave API.
- Fornisci la chiave API a ogni chiamante.
crea una chiave API per ogni chiamante
Se non devi distinguere tra gli utenti che chiamano la tua API, ma vuoi aggiungere limitazioni alle chiavi API, puoi creare una chiave API separata per ogni utente che chiama la tua API nello stesso progetto.
Per creare una chiave API per ogni chiamante nello stesso progetto:
- Nel progetto in cui è configurata l'API o in un progetto che l'API sia abilitata in, creare una chiave API per ogni cliente che dispone Chiave API restrizioni di cui hai bisogno.
- Fornisci la chiave API a ogni chiamante.
Crea un'unica chiave API per tutti i chiamanti
Quando non devi distinguere tra chiamanti della tua API e non devi aggiungere limitazioni per le API, ma vuoi comunque richiedere una chiave API (ad esempio per impedire l'accesso anonimo), puoi creare una chiave API da utilizzare per tutti i chiamanti.
Per creare un'unica chiave API per tutti i chiamanti:- Nel progetto in cui è configurata l'API o in un progetto in cui è abilitata l'API, crea una chiave API per tutti gli utenti chiamanti.
- Fornisci la stessa chiave API a ogni chiamante.