Questo documento spiega come implementare l'autorizzazione OAuth 2.0 per accedere alle API di Google da un'applicazione web JavaScript. OAuth 2.0 consente agli utenti di condividere dati specifici con un'applicazione mantenendo privati i propri nomi utente, password e altre informazioni. Ad esempio, un'applicazione può utilizzare OAuth 2.0 per ottenere l'autorizzazione degli utenti per archiviare i file sui propri Drive.
Questo flusso OAuth 2.0 è chiamato flusso di concessione implicita. È progettato per le applicazioni che accedono alle API solo quando l'utente è presente nell'applicazione. Queste applicazioni non sono in grado di memorizzare informazioni riservate.
In questo flusso la tua app apre un URL Google che utilizza parametri di ricerca per identificare la tua app e il tipo di accesso API richiesto dall'app. Puoi aprire l'URL nella finestra del browser o in un popup correnti. L'utente può eseguire l'autenticazione con Google e concedere le autorizzazioni richieste. Google reindirizza l'utente alla tua app. Il reindirizzamento include un token di accesso, che l'app verifica e che utilizza per effettuare le richieste API.
Prerequisiti
Abilita le API per il tuo progetto
Tutte le applicazioni che chiamano API di Google devono abilitarle nel API Console.
Per abilitare un'API per il progetto:
- Open the API Library in Google API Console.
- If prompted, select a project, or create a new one.
- L'elenco API Library elenca tutte le API disponibili, raggruppate per famiglia di prodotti e popolarità. Se l'API che vuoi attivare non è visibile nell'elenco, utilizza la funzionalità di ricerca per trovarla o fai clic su Visualizza tutto nella famiglia di prodotti a cui appartiene.
- Seleziona l'API che vuoi attivare, quindi fai clic sul pulsante Abilita.
- If prompted, enable billing.
- If prompted, read and accept the API's Terms of Service.
Crea credenziali di autorizzazione
Qualsiasi applicazione che utilizza OAuth 2.0 per accedere alle API di Google deve disporre di credenziali di autorizzazione che identificano il server OAuth 2.0 di Google. I passaggi seguenti spiegano come creare credenziali per il progetto. Le applicazioni possono quindi utilizzare le credenziali per accedere alle API che hai abilitato per il progetto.
- Go to the Credentials page.
- Fai clic su Crea credenziali > ID client OAuth.
- Seleziona il tipo di applicazione Applicazione web.
- Compila il modulo. Le applicazioni che utilizzano JavaScript per effettuare richieste dell'API di Google autorizzate devono specificare le origini JavaScript autorizzate. Le origini identificano i domini da cui la tua applicazione può inviare richieste al server OAuth 2.0. Queste origini devono rispettare le regole di convalida di Google.
Identifica gli ambiti di accesso
Gli ambiti consentono alla tua applicazione di richiedere l'accesso solo alle risorse necessarie e di controllare agli utenti il livello di accesso concesso all'applicazione. Pertanto, potrebbe esistere una relazione inversa tra il numero di ambiti richiesti e la probabilità di ottenere il consenso dell'utente.
Prima di iniziare a implementare l'autorizzazione OAuth 2.0, ti consigliamo di identificare gli ambiti a cui la tua app dovrà avere accesso.
Il documento Ambiti API OAuth 2.0 contiene un elenco completo di ambiti che potresti utilizzare per accedere alle API di Google.
Ottenere i token di accesso OAuth 2.0
I passaggi seguenti mostrano come la tua applicazione interagisce con il server OAuth 2.0 di Google per ottenere il consenso di un utente per eseguire una richiesta API per suo conto. La tua applicazione deve avere questo consenso prima di poter eseguire una richiesta API di Google che richiede l'autorizzazione dell'utente.
Passaggio 1: configura l'oggetto client
Se utilizzi la libreria client delle API di Google per JavaScript per gestire il flusso OAuth 2.0, il primo passaggio consiste nel configurare gli oggetti gapi.auth2 e gapi.client. Questi oggetti consentono alla tua applicazione di ottenere l'autorizzazione dell'utente e di effettuare richieste API autorizzate.
L'oggetto client identifica gli ambiti a cui l'applicazione richiede l'autorizzazione di accesso. Questi valori definiscono la schermata per il consenso che Google mostra all'utente.
Libreria client JS
La libreria client JavaScript semplifica numerosi aspetti del processo di autorizzazione:
- Crea l'URL di reindirizzamento per il server di autorizzazione di Google e fornisce un metodo per indirizzare l'utente a tale URL.
- Gestisce il reindirizzamento dal server alla tua applicazione.
- Convalida il token di accesso restituito dal server di autorizzazione.
- Archivia il token di accesso che il server di autorizzazione invia alla tua applicazione e lo recupera quando la tua app effettua in seguito chiamate API autorizzate.
Lo snippet di codice riportato di seguito è un estratto dell'esempio completo mostrato più avanti in questo documento. Questo codice inizializza l'oggetto gapi.client, che la tua
applicazione utilizzerà in seguito per effettuare chiamate API. Quando viene creato l'oggetto, viene inizializzato anche l'oggetto gapi.auth2, utilizzato dall'applicazione per controllare e monitorare lo stato di autorizzazione dell'utente.
La chiamata a gapi.client.init specifica i seguenti campi:
- I valori
apiKeyeclientIdspecificano le credenziali di autorizzazione dell'applicazione. Come spiegato nella sezione Creazione delle credenziali di autorizzazione, questi valori possono essere ottenuti nella pagina API Console. Tieni presente checlientIdè obbligatorio se la tua applicazione effettua richieste API autorizzate. Le applicazioni che effettuano richieste solo non autorizzate possono specificare semplicemente una chiave API. -
Il campo
scopespecifica un elenco delimitato da spazi di ambiti di accesso che corrispondono alle risorse a cui la tua applicazione potrebbe accedere per conto dell'utente. Questi valori definiscono la schermata per il consenso che Google mostra all'utente.Ti consigliamo di fare in modo che la tua applicazione richieda l'accesso agli ambiti di autorizzazione nel contesto laddove possibile. Richiedendo l'accesso ai dati utente nel contesto, tramite un'autorizzazione incrementale, aiuti gli utenti a comprendere più facilmente perché la tua applicazione ha bisogno dell'accesso che richiede.
- Il campo
discoveryDocsidentifica un elenco di documenti di rilevamento API utilizzati dalla tua applicazione. Un documento di rilevamento descrive la superficie di un'API, inclusi gli schemi delle risorse, e la libreria client JavaScript utilizza tali informazioni per generare metodi che le applicazioni possano utilizzare. In questo esempio, il codice recupera il documento di rilevamento della versione 3 dell'API Google Drive.
Al termine della chiamata gapi.client.init, il codice imposta la variabile GoogleAuth per identificare l'oggetto Google Auth. Infine, il codice imposta un listener che chiama una funzione quando cambia lo stato di accesso dell'utente. Questa funzione non è definita nello snippet.
var GoogleAuth; // Google Auth object.
function initClient() {
gapi.client.init({
'apiKey': 'YOUR_API_KEY',
'clientId': 'YOUR_CLIENT_ID',
'scope': 'https://www.googleapis.com/auth/drive.metadata.readonly',
'discoveryDocs': ['https://www.googleapis.com/discovery/v1/apis/drive/v3/rest']
}).then(function () {
GoogleAuth = gapi.auth2.getAuthInstance();
// Listen for sign-in state changes.
GoogleAuth.isSignedIn.listen(updateSigninStatus);
});
}
Endpoint OAuth 2.0
Se accedi direttamente agli endpoint OAuth 2.0, puoi andare al passaggio successivo.
Passaggio 2: reindirizza al server OAuth 2.0 di Google
Per richiedere l'autorizzazione ad accedere ai dati di un utente, reindirizzalo al server OAuth 2.0 di Google.
Libreria client JS
Chiama il metodo GoogleAuth.signIn() per indirizzare l'utente al
server di autorizzazione di Google.
GoogleAuth.signIn();
In pratica, l'applicazione potrebbe impostare un valore booleano per determinare se chiamare il metodo signIn() prima di tentare di effettuare una chiamata API.
Lo snippet di codice seguente mostra come avviare il flusso di autorizzazione dell'utente. Tieni presente i seguenti punti relativi allo snippet:
-
L'oggetto
GoogleAutha cui viene fatto riferimento nel codice è uguale alla variabile globale definita nello snippet di codice nel passaggio 1. - La funzione
updateSigninStatusè un listener che ascolta le modifiche allo stato di autorizzazione dell'utente. Il suo ruolo di listener è stato definito anche nello snippet di codice nel passaggio 1:GoogleAuth.isSignedIn.listen(updateSigninStatus);
Lo snippet definisce altre due variabili globali:
isAuthorizedè una variabile booleana che indica se l'utente ha già eseguito l'accesso. Questo valore può essere impostato quando l'app viene caricata e aggiornata se l'utente accede o esce dall'app.In questo snippet, la funzione
sendAuthorizedApiRequestcontrolla il valore della variabile per determinare se l'app deve tentare una richiesta API che richiede autorizzazione o richiedere all'utente di autorizzare l'app.currentApiRequestè un oggetto che archivia i dettagli dell'ultima richiesta API che l'utente ha tentato di eseguire. Il valore dell'oggetto viene impostato quando l'app chiama la funzionesendAuthorizedApiRequest.Se l'utente ha autorizzato l'app, la richiesta viene eseguita immediatamente. In caso contrario, la funzione reindirizza l'utente per eseguire l'accesso. Dopo che l'utente ha eseguito l'accesso, la funzione
updateSignInStatuschiamasendAuthorizedApiRequest, trasmettendo la stessa richiesta tentata prima dell'avvio del flusso di autorizzazione.
var isAuthorized;
var currentApiRequest;
/**
* Store the request details. Then check to determine whether the user
* has authorized the application.
* - If the user has granted access, make the API request.
* - If the user has not granted access, initiate the sign-in flow.
*/
function sendAuthorizedApiRequest(requestDetails) {
currentApiRequest = requestDetails;
if (isAuthorized) {
// Make API request
// gapi.client.request(requestDetails)
// Reset currentApiRequest variable.
currentApiRequest = {};
} else {
GoogleAuth.signIn();
}
}
/**
* Listener called when user completes auth flow. If the currentApiRequest
* variable is set, then the user was prompted to authorize the application
* before the request executed. In that case, proceed with that API request.
*/
function updateSigninStatus(isSignedIn) {
if (isSignedIn) {
isAuthorized = true;
if (currentApiRequest) {
sendAuthorizedApiRequest(currentApiRequest);
}
} else {
isAuthorized = false;
}
}
Endpoint OAuth 2.0
Genera un URL per richiedere l'accesso all'endpoint OAuth 2.0 di Google all'indirizzo
https://accounts.google.com/o/oauth2/v2/auth. Questo endpoint è accessibile tramite HTTPS;
le connessioni HTTP semplici vengono rifiutate.
Il server di autorizzazione di Google supporta i seguenti parametri della stringa di query per le applicazioni del server web:
| Parametri | |||||||
|---|---|---|---|---|---|---|---|
client_id |
Obbligatorio
L'ID client della tua applicazione. Questo valore è disponibile in Credentials page API Console. |
||||||
redirect_uri |
Obbligatorio
Determina dove il server API reindirizza l'utente dopo che l'utente ha completato il flusso di autorizzazione. Il valore deve corrispondere esattamente a uno degli URI di reindirizzamento autorizzati per il client OAuth 2.0, configurato nel API Console
Credentials pagedel client. Se questo valore non corrisponde a un URI di reindirizzamento autorizzato per Tieni presente che lo schema |
||||||
response_type |
Obbligatorio
Le applicazioni JavaScript devono impostare il valore del parametro su |
||||||
scope |
Obbligatorio
Un elenco di ambiti delimitato da spazi che identificano le risorse a cui la tua applicazione potrebbe accedere per conto dell'utente. Questi valori definiscono la schermata per il consenso che Google mostra all'utente. Gli ambiti consentono alla tua applicazione di richiedere l'accesso solo alle risorse necessarie, permettendo al contempo agli utenti di controllare il livello di accesso concesso all'applicazione. Pertanto, esiste una relazione inversa tra il numero di ambiti richiesti e la probabilità di ottenere il consenso dell'utente. Ti consigliamo di fare in modo che la tua applicazione richieda l'accesso agli ambiti di autorizzazione nel contesto ogni volta che è possibile. Richiedendo l'accesso ai dati utente nel contesto, tramite autorizzazione incrementale, aiuti gli utenti a comprendere più facilmente il motivo per cui la tua applicazione ha bisogno dell'accesso richiesto. |
||||||
state |
Consigliato
Specifica qualsiasi valore stringa utilizzato dall'applicazione per mantenere lo stato tra la richiesta di autorizzazione e la risposta del server di autorizzazione.
Il server restituisce il valore esatto inviato come coppia Puoi utilizzare questo parametro per diversi scopi, ad esempio per indirizzare l'utente alla risorsa corretta nella tua applicazione, inviare elementi nonce e mitigare la falsificazione di più siti. Poiché è possibile indovinare |
||||||
include_granted_scopes |
Facoltativo
Consente alle applicazioni di utilizzare l'autorizzazione incrementale per richiedere l'accesso ad ambiti aggiuntivi nel contesto. Se imposti il valore di questo parametro su |
||||||
login_hint |
Facoltativo
Se la tua applicazione sa quale utente sta tentando di eseguire l'autenticazione, può utilizzare questo parametro per fornire un suggerimento al server di autenticazione Google. Il server utilizza il suggerimento per semplificare il flusso di accesso precompilando il campo dell'email nel modulo di accesso o selezionando la sessione di accesso multiplo appropriata. Imposta il valore del parametro su un indirizzo email o su un identificatore |
||||||
prompt |
Facoltativo
Un elenco di richieste di presentazione dell'utente, delimitati da maiuscole e minuscole. Se non specifichi questo parametro, all'utente verrà richiesto solo il primo accesso al progetto. Per saperne di più, consulta la sezione Richiesta del consenso. I valori possibili sono:
|
||||||
Esempio di reindirizzamento al server di autorizzazione di Google
Di seguito viene mostrato un URL di esempio con interruzioni di riga e spazi per una migliore leggibilità.
https://accounts.google.com/o/oauth2/v2/auth? scope=https%3A//www.googleapis.com/auth/drive.metadata.readonly& include_granted_scopes=true& response_type=token& state=state_parameter_passthrough_value& redirect_uri=https%3A//oauth2.example.com/code& client_id=client_id
Dopo aver creato l'URL della richiesta, reindirizzalo all'utente.
Codice di esempio JavaScript
Il seguente snippet JavaScript mostra come avviare il flusso di autorizzazione in JavaScript senza utilizzare la libreria client delle API di Google per JavaScript. Poiché questo endpoint OAuth 2.0 non supporta la condivisione delle risorse tra origini (CORS), lo snippet crea un modulo che apre la richiesta a tale endpoint.
/*
* Create form to request access token from Google's OAuth 2.0 server.
*/
function oauthSignIn() {
// Google's OAuth 2.0 endpoint for requesting an access token
var oauth2Endpoint = 'https://accounts.google.com/o/oauth2/v2/auth';
// Create <form> element to submit parameters to OAuth 2.0 endpoint.
var form = document.createElement('form');
form.setAttribute('method', 'GET'); // Send as a GET request.
form.setAttribute('action', oauth2Endpoint);
// Parameters to pass to OAuth 2.0 endpoint.
var params = {'client_id': 'YOUR_CLIENT_ID',
'redirect_uri': 'YOUR_REDIRECT_URI',
'response_type': 'token',
'scope': 'https://www.googleapis.com/auth/drive.metadata.readonly',
'include_granted_scopes': 'true',
'state': 'pass-through value'};
// Add form parameters as hidden input values.
for (var p in params) {
var input = document.createElement('input');
input.setAttribute('type', 'hidden');
input.setAttribute('name', p);
input.setAttribute('value', params[p]);
form.appendChild(input);
}
// Add form to page and submit it to open the OAuth 2.0 endpoint.
document.body.appendChild(form);
form.submit();
}
Passaggio 3: Google chiede all'utente il consenso
In questo passaggio, l'utente decide se concedere alla tua applicazione l'accesso richiesto. In questa fase, Google mostra una finestra di consenso che mostra il nome della tua applicazione e i servizi API di Google per cui richiede l'accesso, con le credenziali di autorizzazione dell'utente e un riepilogo degli ambiti di accesso da concedere. L'utente può quindi concedere l'accesso a uno o più ambiti richiesti dalla tua applicazione o rifiutare la richiesta.
L'applicazione non deve fare nulla in questa fase in attesa della risposta dal server OAuth 2.0 di Google che indica se è stato concesso alcun accesso. Questa risposta è spiegata nel passaggio successivo.
Errori
Le richieste all'endpoint di autorizzazione OAuth 2.0 di Google potrebbero mostrare messaggi di errore rivolti all'utente anziché i flussi di autenticazione e autorizzazione previsti. Di seguito sono elencati i codici di errore comuni e le risoluzioni suggerite.
admin_policy_enforced
L'Account Google non può autorizzare uno o più ambiti richiesti a causa dei criteri del suo amministratore di Google Workspace. Consulta l'articolo del Centro assistenza per amministratori di Google Workspace Controllare quali app di terze parti e interne possono accedere ai dati di Google Workspace per maggiori informazioni su come un amministratore può limitare l'accesso a tutti gli ambiti o agli ambiti sensibili e con restrizioni fino a quando non viene concesso esplicitamente l'accesso al tuo ID client OAuth.
disallowed_useragent
L'endpoint di autorizzazione viene visualizzato all'interno di uno user agent incorporato non consentito dai criteri OAuth 2.0 di Google.
Android
Gli sviluppatori Android potrebbero ricevere questo messaggio di errore quando aprono le richieste di autorizzazione in
android.webkit.WebView.
Gli sviluppatori dovrebbero usare invece librerie Android come Accedi con Google per Android o AppAuth per Android Foundation per Android.
Gli sviluppatori web potrebbero riscontrare questo errore quando un'app per Android apre un link web generale in uno user agent incorporato e un utente accede all'endpoint di autorizzazione OAuth 2.0 di Google dal tuo sito. Gli sviluppatori devono consentire l'apertura dei link generali nel gestore di link predefinito del sistema operativo, che include sia i gestori di link per app Android sia l'app del browser predefinita. Anche la libreria Schede personalizzate di Android è un'opzione supportata.
iOS
Gli sviluppatori iOS e macOS potrebbero riscontrare questo errore quando aprono le richieste di autorizzazione in
WKWebView.
Gli sviluppatori dovrebbero invece utilizzare le librerie iOS come
Accedi con Google per iOS o OpenID Foundation
AppAuth per iOS.
Gli sviluppatori web potrebbero riscontrare questo errore quando un'app per iOS o macOS apre un link web generale in uno user agent incorporato e un utente accede all'endpoint di autorizzazione OAuth 2.0 di Google dal tuo sito. Gli sviluppatori devono consentire l'apertura dei link generali nel gestore di link predefinito del sistema operativo, che include sia i gestori di Universal Links sia l'app del browser predefinita. Anche la libreria SFSafariViewController è un'opzione supportata.
org_internal
L'ID client OAuth nella richiesta fa parte di un progetto che limita l'accesso agli Account Google in una organizzazione Google Cloud specifica. Per scoprire di più su questa opzione di configurazione, consulta la sezione Tipo di utente nell'articolo del Centro assistenza Configurare la schermata per il consenso OAuth.
invalid_client
L'origine da cui è stata effettuata la richiesta non è autorizzata per questo client. Consulta
origin_mismatch.
invalid_grant
Quando utilizzi l'autorizzazione incrementale, il token potrebbe essere scaduto o è stato invalidato. Autentica di nuovo l'utente e chiedi il suo consenso per ottenere nuovi token. Se continui a visualizzare questo errore, assicurati che l'applicazione sia stata configurata correttamente e di utilizzare i token e i parametri corretti nella richiesta. Altrimenti, l'account utente potrebbe essere stato eliminato o disattivato.
origin_mismatch
Lo schema, il dominio e/o la porta di JavaScript che ha origine la richiesta di autorizzazione potrebbero non corrispondere a un URI di origine JavaScript autorizzato registrato per l'ID client OAuth. Esamina le origini JavaScript autorizzate in Google API Console Credentials page.
redirect_uri_mismatch
Il redirect_uri trasmesso nella richiesta di autorizzazione non corrisponde a un URI di reindirizzamento autorizzato per l'ID client OAuth. Esamina gli URI di reindirizzamento autorizzati in Google API Console Credentials page.
Lo schema, il dominio e/o la porta di JavaScript che ha origine la richiesta di autorizzazione potrebbero non corrispondere a un URI di origine JavaScript autorizzato registrato per l'ID client OAuth. Esamina le origini JavaScript autorizzate in Google API Console Credentials page.
Il parametro redirect_uri potrebbe fare riferimento al flusso OAuth fuori banda che è stato ritirato e non è più supportato. Consulta la guida alla migrazione per aggiornare l'integrazione.
Passaggio 4: gestisci la risposta del server OAuth 2.0
Libreria client JS
La libreria client JavaScript gestisce la risposta dal server di autorizzazione di Google. Se imposti un listener per monitorare le modifiche nello stato di accesso dell'utente corrente, tale funzione viene chiamata quando l'utente concede l'accesso richiesto all'applicazione.
Endpoint OAuth 2.0
Il server OAuth 2.0 invia una risposta al redirect_uri specificato nella richiesta di token di accesso.
Se l'utente approva la richiesta, la risposta contiene un token di accesso. Se l'utente non approva la richiesta, la risposta contiene un messaggio di errore. Il token di accesso o il messaggio di errore viene restituito nel frammento hash dell'URI di reindirizzamento, come mostrato di seguito:
Una risposta del token di accesso:
https://oauth2.example.com/callback#access_token=4/P7q7W91&token_type=Bearer&expires_in=3600
Oltre al parametro
access_token, la stringa di frammenti contiene anche il parametrotoken_type, sempre impostato suBearer, e il parametroexpires_in, che specifica la durata del token, in secondi. Se il parametrostateè stato specificato nella richiesta del token di accesso, anche il suo valore è incluso nella risposta.- Una risposta di errore:
https://oauth2.example.com/callback#error=access_denied
Esempio di risposta del server OAuth 2.0
Puoi testare questo flusso facendo clic sul seguente URL di esempio, che richiede l'accesso in sola lettura per visualizzare i metadati per i file su Google Drive:
https://accounts.google.com/o/oauth2/v2/auth? scope=https%3A//www.googleapis.com/auth/drive.metadata.readonly& include_granted_scopes=true& response_type=token& state=state_parameter_passthrough_value& redirect_uri=https%3A//oauth2.example.com/code& client_id=client_id
Una volta completata la procedura OAuth 2.0, verrai reindirizzato a http://localhost/oauth2callback. Questo URL restituirà un errore
404 NOT FOUND a meno che la macchina locale non pubblichi un file a
quell'indirizzo. Il passaggio successivo fornisce ulteriori dettagli sulle informazioni restituite nell'URI quando l'utente viene reindirizzato alla tua applicazione.
Chiamata alle API di Google
Libreria client JS
Dopo che l'applicazione ha ottenuto un token di accesso, puoi utilizzare la libreria client JavaScript per effettuare richieste API per conto dell'utente. La libreria client gestisce il token di accesso per te e non devi fare nulla di speciale per inviarlo nella richiesta.
La libreria client supporta due modi per chiamare metodi API. Se hai caricato un documento di rilevamento, l'API definisce automaticamente le funzioni specifiche del metodo. Puoi anche utilizzare la funzione gapi.client.request per chiamare un metodo API.
I due snippet seguenti illustrano queste opzioni per il metodo about.get dell'API Drive.
// Example 1: Use method-specific function
var request = gapi.client.drive.about.get({'fields': 'user'});
// Execute the API request.
request.execute(function(response) {
console.log(response);
});
// Example 2: Use gapi.client.request(args) function
var request = gapi.client.request({
'method': 'GET',
'path': '/drive/v3/about',
'params': {'fields': 'user'}
});
// Execute the API request.
request.execute(function(response) {
console.log(response);
});
Endpoint OAuth 2.0
Dopo che l'applicazione ha ottenuto un token di accesso, puoi utilizzarlo per effettuare chiamate a un'API Google
per conto di un determinato
account utente se sono stati concessi gli ambiti di accesso richiesti dall'API. A tale scopo, includi il token di accesso in una richiesta all'API includendo un parametro di ricerca access_token o un valore di intestazione HTTP Authorization Bearer. Quando possibile, è preferibile l'intestazione HTTP, perché le stringhe di query tendono a essere visibili nei log del server. Nella maggior parte dei casi puoi utilizzare una libreria client per configurare le tue chiamate alle API di Google (ad esempio, quando chiamate l'API Drive Files).
Puoi provare tutte le API di Google e visualizzarne gli ambiti su OAuth 2.0 Playground.
Esempi HTTP GET
Una chiamata all'endpoint
drive.files (l'API Drive File) utilizzando l'intestazione HTTP Authorization: Bearer potrebbe avere il seguente aspetto. Tieni presente che devi specificare il tuo token di accesso:
GET /drive/v2/files HTTP/1.1 Host: www.googleapis.com Authorization: Bearer access_token
Ecco una chiamata alla stessa API per l'utente autenticato utilizzando il parametro della stringa di query access_token:
GET https://www.googleapis.com/drive/v2/files?access_token=access_token
Esempi di curl
Puoi testare questi comandi con l'applicazione a riga di comando curl. Ecco un
esempio che utilizza l'opzione intestazione HTTP (opzione preferita):
curl -H "Authorization: Bearer access_token" https://www.googleapis.com/drive/v2/files
In alternativa, l'opzione del parametro della stringa di query:
curl https://www.googleapis.com/drive/v2/files?access_token=access_token
Codice di esempio JavaScript
Lo snippet di codice riportato di seguito mostra come utilizzare CORS (condivisione delle risorse multiorigine) per inviare una richiesta a un'API Google. Questo esempio non utilizza la libreria client delle API di Google per JavaScript. Tuttavia, anche se non utilizzi la libreria client, la guida dell'assistenza CORS nella documentazione della libreria ti aiuterà a comprendere meglio queste richieste.
In questo snippet di codice, la variabile access_token rappresenta il token che hai ottenuto per effettuare richieste API per conto dell'utente autorizzato. L'esempio
completo mostra come archiviare il token nello spazio di archiviazione locale del browser e recuperarlo
quando effettui una richiesta API.
var xhr = new XMLHttpRequest();
xhr.open('GET',
'https://www.googleapis.com/drive/v3/about?fields=user&' +
'access_token=' + params['access_token']);
xhr.onreadystatechange = function (e) {
console.log(xhr.response);
};
xhr.send(null);
Completa esempio
Libreria client JS
Esempio di demo del codice
Questa sezione contiene una demo funzionante dell'esempio di codice che segue per dimostrare il comportamento del codice in un'app reale. Dopo aver autorizzato l'app, questa viene elencata tra le app collegate al tuo Account Google. L'app è denominata OAuth 2.0 Demo per i documenti dell'API di Google. Analogamente, se revochi l'accesso e aggiorni la pagina, l'app non sarà più elencata.
Tieni presente che questa app richiede l'accesso all'ambito https://www.googleapis.com/auth/drive.metadata.readonly. L'accesso
è richiesto solo per dimostrare come avviare il flusso OAuth 2.0 in un'applicazione JavaScript.
Questa app non invia richieste API.
Codice di esempio JavaScript
Come mostrato sopra, questo esempio di codice riguarda una pagina (un'app) che carica la libreria client delle API di Google per JavaScript e avvia il flusso OAuth 2.0. Nella pagina vengono visualizzati i seguenti elementi:
- Un pulsante che consente all'utente di accedere all'app. Se l'utente non ha precedentemente autorizzato l'app, questa avvia il flusso OAuth 2.0.
- Due pulsanti che consentono all'utente di uscire dall'app o di revocare l'accesso concesso in precedenza. Se esci dall'app, non ne hai revocato l'accesso. Dovrai accedere di nuovo prima che l'app possa effettuare altre richieste autorizzate per tuo conto, ma non dovrai concedere di nuovo l'accesso la prossima volta che utilizzi l'app. Tuttavia, se revochi l'accesso, devi concedere di nuovo l'accesso.
Puoi anche revocare l'accesso all'app tramite la pagina Autorizzazioni del tuo Account Google. L'app è elencata come Demo OAuth 2.0 per i documenti dell'API di Google.
<script>
var GoogleAuth;
var SCOPE = 'https://www.googleapis.com/auth/drive.metadata.readonly';
function handleClientLoad() {
// Load the API's client and auth2 modules.
// Call the initClient function after the modules load.
gapi.load('client:auth2', initClient);
}
function initClient() {
// In practice, your app can retrieve one or more discovery documents.
var discoveryUrl = 'https://www.googleapis.com/discovery/v1/apis/drive/v3/rest';
// Initialize the gapi.client object, which app uses to make API requests.
// Get API key and client ID from API Console.
// 'scope' field specifies space-delimited list of access scopes.
gapi.client.init({
'apiKey': 'YOUR_API_KEY',
'clientId': 'YOUR_CLIENT_ID',
'discoveryDocs': [discoveryUrl],
'scope': SCOPE
}).then(function () {
GoogleAuth = gapi.auth2.getAuthInstance();
// Listen for sign-in state changes.
GoogleAuth.isSignedIn.listen(updateSigninStatus);
// Handle initial sign-in state. (Determine if user is already signed in.)
var user = GoogleAuth.currentUser.get();
setSigninStatus();
// Call handleAuthClick function when user clicks on
// "Sign In/Authorize" button.
$('#sign-in-or-out-button').click(function() {
handleAuthClick();
});
$('#revoke-access-button').click(function() {
revokeAccess();
});
});
}
function handleAuthClick() {
if (GoogleAuth.isSignedIn.get()) {
// User is authorized and has clicked "Sign out" button.
GoogleAuth.signOut();
} else {
// User is not signed in. Start Google auth flow.
GoogleAuth.signIn();
}
}
function revokeAccess() {
GoogleAuth.disconnect();
}
function setSigninStatus() {
var user = GoogleAuth.currentUser.get();
var isAuthorized = user.hasGrantedScopes(SCOPE);
if (isAuthorized) {
$('#sign-in-or-out-button').html('Sign out');
$('#revoke-access-button').css('display', 'inline-block');
$('#auth-status').html('You are currently signed in and have granted ' +
'access to this app.');
} else {
$('#sign-in-or-out-button').html('Sign In/Authorize');
$('#revoke-access-button').css('display', 'none');
$('#auth-status').html('You have not authorized this app or you are ' +
'signed out.');
}
}
function updateSigninStatus() {
setSigninStatus();
}
</script>
<button id="sign-in-or-out-button"
style="margin-left: 25px">Sign In/Authorize</button>
<button id="revoke-access-button"
style="display: none; margin-left: 25px">Revoke access</button>
<div id="auth-status" style="display: inline; padding-left: 25px"></div><hr>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
<script async defer src="https://apis.google.com/js/api.js"
onload="this.onload=function(){};handleClientLoad()"
onreadystatechange="if (this.readyState === 'complete') this.onload()">
</script>
Endpoint OAuth 2.0
Questo esempio di codice mostra come completare il flusso OAuth 2.0 in JavaScript senza utilizzare la libreria client delle API di Google per JavaScript. Il codice riguarda una pagina HTML che mostra un pulsante per provare una richiesta API. Se fai clic sul pulsante, il codice controlla se nella pagina è stato archiviato un token di accesso all'API nello spazio di archiviazione locale del tuo browser. In questo caso, esegue la richiesta API. In caso contrario, avvia il flusso OAuth 2.0.
Per il flusso OAuth 2.0, la pagina segue questi passaggi:
- Indirizza l'utente al server OAuth 2.0 di Google, che richiede l'accesso all'ambito di
https://www.googleapis.com/auth/drive.metadata.readonly. - Dopo aver concesso (o negato) l'accesso a uno o più ambiti richiesti, l'utente viene reindirizzato alla pagina originale, che analizza il token di accesso dalla stringa dell'identificatore di frammento.
La pagina utilizza il token di accesso per effettuare la richiesta API di esempio.
La richiesta API chiama il metodo
about.getdell'API Drive per recuperare informazioni sull'account Google Drive dell'utente autorizzato.- Se la richiesta viene eseguita correttamente, la risposta API viene registrata nella console di debug del browser.
Puoi revocare l'accesso all'app tramite la pagina Autorizzazioni del tuo Account Google. L'app verrà elencata come Demo OAuth 2.0 per i documenti dell'API di Google.
Per eseguire questo codice in locale, devi impostare i valori delle variabili YOUR_CLIENT_ID e YOUR_REDIRECT_URI che corrispondono alle tue credenziali di autorizzazione. La variabile YOUR_REDIRECT_URI deve essere impostata sullo stesso URL in cui viene pubblicata la pagina. Il valore deve corrispondere esattamente a uno degli URI di reindirizzamento autorizzati per il client OAuth 2.0, configurato nella API Console Credentials page. Se
questo valore non corrisponde a un URI autorizzato, riceverai un errore
redirect_uri_mismatch. Il tuo progetto deve inoltre aver attivato l'API appropriata per questa richiesta.
<html><head></head><body>
<script>
var YOUR_CLIENT_ID = 'REPLACE_THIS_VALUE';
var YOUR_REDIRECT_URI = 'REPLACE_THIS_VALUE';
var fragmentString = location.hash.substring(1);
// Parse query string to see if page request is coming from OAuth 2.0 server.
var params = {};
var regex = /([^&=]+)=([^&]*)/g, m;
while (m = regex.exec(fragmentString)) {
params[decodeURIComponent(m[1])] = decodeURIComponent(m[2]);
}
if (Object.keys(params).length > 0) {
localStorage.setItem('oauth2-test-params', JSON.stringify(params) );
if (params['state'] && params['state'] == 'try_sample_request') {
trySampleRequest();
}
}
// If there's an access token, try an API request.
// Otherwise, start OAuth 2.0 flow.
function trySampleRequest() {
var params = JSON.parse(localStorage.getItem('oauth2-test-params'));
if (params && params['access_token']) {
var xhr = new XMLHttpRequest();
xhr.open('GET',
'https://www.googleapis.com/drive/v3/about?fields=user&' +
'access_token=' + params['access_token']);
xhr.onreadystatechange = function (e) {
if (xhr.readyState === 4 && xhr.status === 200) {
console.log(xhr.response);
} else if (xhr.readyState === 4 && xhr.status === 401) {
// Token invalid, so prompt for user permission.
oauth2SignIn();
}
};
xhr.send(null);
} else {
oauth2SignIn();
}
}
/*
* Create form to request access token from Google's OAuth 2.0 server.
*/
function oauth2SignIn() {
// Google's OAuth 2.0 endpoint for requesting an access token
var oauth2Endpoint = 'https://accounts.google.com/o/oauth2/v2/auth';
// Create element to open OAuth 2.0 endpoint in new window.
var form = document.createElement('form');
form.setAttribute('method', 'GET'); // Send as a GET request.
form.setAttribute('action', oauth2Endpoint);
// Parameters to pass to OAuth 2.0 endpoint.
var params = {'client_id': YOUR_CLIENT_ID,
'redirect_uri': YOUR_REDIRECT_URI,
'scope': 'https://www.googleapis.com/auth/drive.metadata.readonly',
'state': 'try_sample_request',
'include_granted_scopes': 'true',
'response_type': 'token'};
// Add form parameters as hidden input values.
for (var p in params) {
var input = document.createElement('input');
input.setAttribute('type', 'hidden');
input.setAttribute('name', p);
input.setAttribute('value', params[p]);
form.appendChild(input);
}
// Add form to page and submit it to open the OAuth 2.0 endpoint.
document.body.appendChild(form);
form.submit();
}
</script>
<button onclick="trySampleRequest();">Try sample request</button>
</body></html>
Regole di convalida dell'origine JavaScript
Google applica le seguenti regole di convalida alle origini JavaScript per aiutare gli sviluppatori a proteggere le proprie applicazioni. Le origini JavaScript devono rispettare queste regole. Consulta la sezione 3986 del documento RFC 3 per la definizione di dominio, host e schema, di seguito riportati.
| Regole di convalida | |
|---|---|
| Schema |
Le origini JavaScript devono utilizzare lo schema HTTPS, non un semplice HTTP. Gli URI Localhost (inclusi gli URI IP host locali) sono esenti da questa regola. |
| Host |
Gli host non possono essere indirizzi IP non elaborati. Gli indirizzi IP Localhost sono esenti da questa regola. |
| Dominio |
“googleusercontent.com”.goo.gl) a meno che l'app non sia proprietaria del dominio. |
| Informazioni utente |
Le origini JavaScript non possono contenere il sottocomponente userinfo. |
| Percorso |
Le origini JavaScript non possono contenere il componente del percorso. |
| Query |
Le origini JavaScript non possono contenere il componente della query. |
| Frammento |
Le origini JavaScript non possono contenere il componente frammento. |
| Caratteri |
Le origini JavaScript non possono contenere alcuni caratteri, tra cui:
|
Autorizzazione incrementale
Nel protocollo OAuth 2.0, la tua app richiede l'autorizzazione per accedere alle risorse, identificate dagli ambiti. È considerata una best practice per l'esperienza utente richiedere l'autorizzazione delle risorse nel momento in cui ne hai bisogno. Per abilitare tale pratica, il server di autorizzazione di Google supporta l'autorizzazione incrementale. Questa funzionalità consente di richiedere gli ambiti in base alle necessità e, se l'utente concede l'autorizzazione per il nuovo ambito, restituisce un codice di autorizzazione che può essere scambiato con un token contenente tutti gli ambiti che l'utente ha concesso al progetto.
Ad esempio, un'app che consente di campionare tracce musicali e creare mix potrebbe richiedere pochissime risorse al momento dell'accesso, forse solo il nome della persona che effettua l'accesso. Tuttavia, il salvataggio di un mix completato richiede l'accesso a Google Drive. Per la maggior parte delle persone sarebbe naturale se fosse stato loro richiesto di accedere a Google Drive nel momento in cui l'applicazione ne avesse effettivamente bisogno.
In questo caso, al momento dell'accesso l'app potrebbe richiedere gli ambiti openid e profile per eseguire l'accesso di base, per poi richiedere l'ambito https://www.googleapis.com/auth/drive.file al momento della prima richiesta per salvare un mix.
A un token di accesso ottenuto da un'autorizzazione incrementale si applicano le seguenti regole:
- Il token può essere utilizzato per accedere alle risorse corrispondenti a qualsiasi ambito inserito nella nuova autorizzazione combinata.
- Quando utilizzi il token di aggiornamento per l'autorizzazione combinata per ottenere un token di accesso, questo
rappresenta l'autorizzazione combinata e può essere utilizzato per qualsiasi
valore
scopeincluso nella risposta. - L'autorizzazione combinata include tutti gli ambiti che l'utente ha concesso al progetto API anche se le concessioni sono state richieste da client diversi. Ad esempio, se un utente ha concesso l'accesso a un ambito utilizzando il client desktop di un'applicazione e poi ha concesso un altro ambito alla stessa applicazione tramite un client per dispositivi mobili, l'autorizzazione combinata includerà entrambi gli ambiti.
- Se revochi un token che rappresenta un'autorizzazione combinata, l'accesso a tutti gli ambiti di tale autorizzazione per conto dell'utente associato viene revocato.
Gli esempi di codice riportati di seguito mostrano come aggiungere ambiti a un token di accesso esistente. Questo approccio consente alla tua app di evitare di dover gestire più token di accesso.
Libreria client JS
Per aggiungere ambiti a un token di accesso esistente, chiama il metodo GoogleUser.grant(options). L'oggetto options identifica gli ambiti aggiuntivi a cui vuoi concedere
l'accesso.
// Space-separated list of additional scope(s) you are requesting access to.
// This code adds read-only access to the user's calendars via the Calendar API.
var NEW_SCOPES = 'https://www.googleapis.com/auth/calendar.readonly';
// Retrieve the GoogleUser object for the current user.
var GoogleUser = GoogleAuth.currentUser.get();
GoogleUser.grant({'scope': NEW_SCOPES});
Endpoint OAuth 2.0
Per aggiungere ambiti a un token di accesso esistente, includi il parametro include_granted_scopes nella richiesta al server OAuth 2.0 di Google.
Il seguente snippet di codice dimostra come fare. Lo snippet presuppone che tu abbia memorizzato gli ambiti per i quali il token di accesso è valido nello spazio di archiviazione locale del browser. Il codice complete example archivia un elenco di ambiti per cui il token di accesso è valido impostando la proprietà oauth2-test-params.scope nello spazio di archiviazione locale del browser.
Lo snippet confronta gli ambiti per i quali il token di accesso è valido con l'ambito da utilizzare per una determinata query. Se il token di accesso non copre questo ambito, viene avviato il flusso OAuth 2.0.
Qui, la funzione oauth2SignIn è la stessa fornita nel
passaggio 2 (e fornita più avanti nell'esempio
completo).
var SCOPE = 'https://www.googleapis.com/auth/drive.metadata.readonly';
var params = JSON.parse(localStorage.getItem('oauth2-test-params'));
var current_scope_granted = false;
if (params.hasOwnProperty('scope')) {
var scopes = params['scope'].split(' ');
for (var s = 0; s < scopes.length; s++) {
if (SCOPE == scopes[s]) {
current_scope_granted = true;
}
}
}
if (!current_scope_granted) {
oauth2SignIn(); // This function is defined elsewhere in this document.
} else {
// Since you already have access, you can proceed with the API request.
}
Revoca di un token
In alcuni casi, un utente potrebbe voler revocare l'accesso concesso a un'applicazione. Un utente può revocare l'accesso dalla pagina Impostazioni account. Per scoprire di più, consulta la sezione Rimuovere l'accesso ai siti o alle app dei siti di terze parti e le app con accesso al tuo account.
È anche possibile che un'applicazione revoca l'accesso concesso in modo programmatico. La revoca programmatica è importante nei casi in cui un utente annulla l'iscrizione, rimuove un'applicazione o le risorse API richieste da un'app sono cambiate in modo significativo. In altre parole, una parte del processo di rimozione può includere una richiesta API per garantire che le autorizzazioni concesse in precedenza all'applicazione vengano rimosse.
Libreria client JS
Per revocare un token a livello di programmazione, chiama
GoogleAuth.disconnect():
GoogleAuth.disconnect();
Endpoint OAuth 2.0
Per revocare un token in modo programmatico, l'applicazione invia una richiesta a https://oauth2.googleapis.com/revoke e include il token come parametro:
curl -d -X -POST --header "Content-type:application/x-www-form-urlencoded" \
https://oauth2.googleapis.com/revoke?token={token}
Il token può essere un token di accesso o un token di aggiornamento. Se il token è un token di accesso e presenta un token di aggiornamento corrispondente, anche il token di aggiornamento verrà revocato.
Se la revoca viene elaborata correttamente, il codice di stato HTTP della risposta è 200. Per le condizioni di errore, viene restituito un codice di stato HTTP 400 e un codice di errore.
Il seguente snippet JavaScript mostra come revocare un token in JavaScript senza utilizzare la libreria client delle API di Google per JavaScript. Poiché l'endpoint OAuth 2.0 di Google per la revoca
dei token non supporta la condivisione delle risorse tra origini (CORS), il codice crea un modulo e invia
il modulo all'endpoint anziché utilizzare il metodo XMLHttpRequest() per pubblicare la
richiesta.
function revokeAccess(accessToken) {
// Google's OAuth 2.0 endpoint for revoking access tokens.
var revokeTokenEndpoint = 'https://oauth2.googleapis.com/revoke';
// Create <form> element to use to POST data to the OAuth 2.0 endpoint.
var form = document.createElement('form');
form.setAttribute('method', 'post');
form.setAttribute('action', revokeTokenEndpoint);
// Add access token to the form so it is set as value of 'token' parameter.
// This corresponds to the sample curl request, where the URL is:
// https://oauth2.googleapis.com/revoke?token={token}
var tokenField = document.createElement('input');
tokenField.setAttribute('type', 'hidden');
tokenField.setAttribute('name', 'token');
tokenField.setAttribute('value', accessToken);
form.appendChild(tokenField);
// Add form to page and submit it to actually revoke the token.
document.body.appendChild(form);
form.submit();
}