Requisiti di autenticazione dell'API Search Console
Ogni richiesta inviata dalla tua applicazione all'API Google Search Console deve includere un token di autorizzazione. Il token, inoltre, identifica l'applicazione per Google.
Informazioni sui protocolli di autorizzazione
La tua applicazione deve utilizzare il protocollo OAuth 2.0 per autorizzare le richieste. Non sono supportati altri protocolli di autorizzazione. Se la tua applicazione utilizza la funzionalità Accedi con Google, alcuni aspetti dell'autorizzazione vengono gestiti per te.
Autorizzazione delle richieste con OAuth 2.0
Tutte le richieste all'API Google Search Console devono essere autorizzate da un utente autenticato.
I dettagli della procedura di autorizzazione, o "flusso", per il protocollo OAuth 2.0 variano a seconda del tipo di applicazione che stai scrivendo. La seguente procedura generale si applica a tutti i tipi di applicazione:
- Quando crei la tua applicazione, la registri utilizzando la console API di Google. Quindi, Google fornisce informazioni che ti saranno necessarie in un secondo momento, ad esempio un ID client e un client secret.
- Attiva l'API Google Search Console nella console API di Google. (Se l'API non è elencata nella console API, salta questo passaggio.)
- Quando la tua applicazione vuole accedere ai dati dell'utente, chiede a Google un particolare ambito di accesso.
- Google mostra una schermata di consenso all'utente, chiedendo di autorizzare l'applicazione a richiedere dei dati.
- Se l'utente approva, Google fornisce alla tua applicazione un token di accesso di breve durata.
- L'applicazione richiede i dati utente, allegando il token di accesso alla richiesta.
- Se Google ritiene validi la richiesta e il token, restituisce i dati richiesti.
Alcuni flussi includono passaggi aggiuntivi, come l'uso di token di aggiornamento per acquisire nuovi token di accesso. Per informazioni dettagliate sui flussi per vari tipi di applicazioni, consulta la documentazione relativa al protocollo OAuth 2.0 di Google.
Di seguito sono riportate le informazioni relative all'ambito OAuth 2.0 per l'API Google Search Console:
| Ambito | Significato |
|---|---|
https://www.googleapis.com/auth/webmasters |
Accesso di lettura/scrittura. |
https://www.googleapis.com/auth/webmasters.readonly |
Accesso di sola lettura. |
Per richiedere l'accesso utilizzando il protocollo OAuth 2.0, l'applicazione richiede le informazioni relative all'ambito e le informazioni che Google fornisce quando registri la tua applicazione (ad esempio l'ID client e il client secret).
Suggerimento: le librerie client delle API di Google possono gestire parte del processo di autorizzazione per te. Sono disponibili per una varietà di linguaggi di programmazione; consulta la pagina delle librerie e dei campioni per maggiori dettagli.
Requisiti di autenticazione dell'API Search Console Testing Tools
Acquisizione e utilizzo di una chiave API
Le richieste all'API Search Console Testing Tools per i dati pubblici devono essere accompagnate da un identificatore, che può essere una chiave API o un token di accesso.
Per acquisire una chiave API:
- Apri la pagina Credenziali nella console API.
-
Questa API supporta due tipi di credenziali.
Crea le credenziali appropriate per il tuo progetto:
-
OAuth 2.0:ogni volta che l'applicazione richiede dati privati dell'utente, deve inviare un token OAuth 2.0 insieme alla richiesta. L'applicazione invia innanzitutto un ID client e, possibilmente, un client secret per ottenere un token. Puoi generare credenziali OAuth 2.0 per applicazioni web, account di servizio o applicazioni installate.
Per ulteriori informazioni, consulta la documentazione relativa a OAuth 2.0.
-
Chiavi API: una richiesta che non fornisce un token OAuth 2.0 deve inviare una chiave API. La chiave identifica il progetto e fornisce accesso API, quota e report.
L'API supporta diversi tipi di limitazioni sulle chiavi API. Se la chiave API di cui hai bisogno non esiste già, creane una nella console facendo clic su Crea credenziali > Chiave API. Puoi limitare la chiave prima di utilizzarla in produzione facendo clic su Limita chiave e selezionando una delle Restrizioni.
-
Per proteggere le tue chiavi API, segui le best practice per l'utilizzo sicuro delle chiavi API.
Dopo aver ottenuto una chiave API, l'applicazione può aggiungere il parametro di query
key=yourAPIKey a tutti gli URL delle richieste.
La chiave API è sicura per l'incorporamento negli URL; non è necessaria alcuna codifica.