Este documento explica como implementar a autorização do OAuth 2.0 para acessar as APIs do Google por meio de aplicativos executados em dispositivos como TVs, consoles de jogos e impressoras. Mais especificamente, esse fluxo foi projetado para dispositivos que não têm acesso a um navegador ou têm recursos limitados de entrada.
O OAuth 2.0 permite que os usuários compartilhem dados específicos com um aplicativo, mantendo os nomes de usuário, senhas e outras informações privadas. Por exemplo, um app para TV pode usar o OAuth 2.0 para ter permissão para selecionar um arquivo armazenado no Google Drive.
Como os aplicativos que usam esse fluxo são distribuídos para dispositivos individuais, presume-se que os aplicativos não podem manter secrets. Eles podem acessar as APIs do Google enquanto o usuário está no app ou quando ele está em segundo plano.
Alternativas
Se você estiver criando um app para uma plataforma como Android, iOS, macOS, Linux ou Windows (incluindo a Plataforma Universal Windows), que tem acesso ao navegador e a todos os recursos de entrada, use o fluxo do OAuth 2.0 para apps para dispositivos móveis e computador. Use esse fluxo mesmo que o app seja uma ferramenta de linha de comando sem uma interface gráfica.
Se você só quiser fazer login dos usuários com as Contas do Google deles e usar o token de ID do JWT para receber informações básicas de perfil do usuário, consulte Fazer login em TVs e dispositivos de entrada limitados.
Prerequisites
Ativar as APIs do projeto
Todo aplicativo que chama APIs do Google precisa ativar essas APIs no API Console.
Para ativar uma API para um projeto, faça o seguinte:
- Open the API Library no Google API Console.
- If prompted, select a project, or create a new one.
- A API Library lista todas as APIs disponíveis agrupadas por família de produtos e popularidade. Se a API que você quer ativar não estiver visível na lista, use a pesquisa para encontrá-la ou clique em Ver tudo na família de produtos à qual ela pertence.
- Selecione a API que você quer ativar e clique no botão Ativar.
- If prompted, enable billing.
- If prompted, read and accept the API's Terms of Service.
Criar credenciais de autorização
Qualquer aplicativo que use o OAuth 2.0 para acessar as APIs do Google precisa ter credenciais de autorização que identifiquem o aplicativo para o servidor OAuth 2.0 do Google. As etapas a seguir explicam como criar credenciais para seu projeto. Os aplicativos poderão usar as credenciais para acessar as APIs ativadas para o projeto.
- Go to the Credentials page.
- Clique em Criar credenciais > ID do cliente OAuth.
- Selecione o tipo de aplicativo TVs e dispositivos de entrada limitada.
- Nomeie seu cliente OAuth 2.0 e clique em Criar.
Identificar escopos de acesso
Os escopos permitem que o aplicativo solicite acesso apenas aos recursos necessários, além de permitir que os usuários controlem o acesso concedido ao aplicativo. Portanto, pode haver uma relação inversa entre o número de escopos solicitados e a probabilidade de aprovação do usuário.
Antes de começar a implementar a autorização do OAuth 2.0, recomendamos que você identifique os escopos que seu app precisará de permissão para acessar.
Consulte a lista Escopos permitidos para apps ou dispositivos instalados.
Como acessar tokens de acesso do OAuth 2.0
Mesmo que o app seja executado em um dispositivo com recursos de entrada limitados, os usuários precisam ter acesso separado a um dispositivo com recursos de entrada mais avançados para concluir esse fluxo de autorização. O fluxo tem as seguintes etapas:
- Seu aplicativo envia uma solicitação ao servidor de autorização do Google que identifica os escopos que seu aplicativo solicitará permissão de acesso.
- O servidor responde com várias informações usadas nas etapas subsequentes, como um código de dispositivo e um código de usuário.
- Você exibe informações que o usuário pode inserir em outro dispositivo para autorizar o app.
- Seu aplicativo começa a sondar o servidor de autorização do Google para determinar se o usuário autorizou seu aplicativo.
- O usuário alterna para um dispositivo com recursos de entrada mais avançados, inicia um navegador da Web, navega para o URL exibido na etapa 3 e insere um código que também é exibido na etapa 3. O usuário pode conceder ou negar o acesso ao aplicativo.
- A próxima resposta à solicitação de pesquisa contém os tokens necessários para o app autorizar solicitações em nome do usuário. Se o usuário tiver recusado o acesso ao aplicativo, a resposta não conterá tokens.
A imagem abaixo ilustra esse processo:
As seções a seguir explicam essas etapas em detalhes. Considerando a variedade de recursos e ambientes de execução que os dispositivos podem ter, os exemplos mostrados neste documento usam o utilitário de linha de comando curl. Estes exemplos precisam ser fáceis de transferir para vários idiomas e ambientes de execução.
Etapa 1: solicitar códigos do dispositivo e do usuário
Nesta etapa, o dispositivo envia uma solicitação POST HTTP para o servidor de autorização do Google, em https://oauth2.googleapis.com/device/code, que identifica seu aplicativo, bem como os escopos de acesso que ele quer acessar em nome do usuário.
É preciso recuperar esse URL do
documento de descoberta usando o
valor de metadados device_authorization_endpoint. Inclua os seguintes parâmetros de solicitação HTTP:
| Parâmetros | |
|---|---|
client_id |
Obrigatório
O ID do cliente do seu aplicativo. Esse valor está no API Console Credentials page. |
scope |
Obrigatório
Uma lista de escopos delimitada por espaço que identificam os recursos que seu aplicativo pode acessar em nome do usuário. Esses valores informam a tela de consentimento que o Google exibe ao usuário. Consulte a lista Escopos permitidos para apps ou dispositivos instalados. Os escopos permitem que o aplicativo solicite acesso apenas aos recursos necessários, além de permitir que os usuários controlem o acesso concedido ao aplicativo. Assim, há uma relação inversa entre o número de escopos solicitados e a probabilidade de recebimento do consentimento do usuário. |
Examples
O snippet a seguir mostra um exemplo de solicitação:
POST /device/code HTTP/1.1 Host: oauth2.googleapis.com Content-Type: application/x-www-form-urlencoded client_id=client_id&scope=
Este exemplo mostra um comando curl para enviar a mesma solicitação:
curl -d "client_id=client_id&scope=" \
https://oauth2.googleapis.com/device/code
Etapa 2: processar a resposta do servidor de autorização
O servidor de autorização retornará uma das seguintes respostas:
Resposta de sucesso
Se a solicitação for válida, sua resposta será um objeto JSON que contém as seguintes propriedades:
| Propriedades | |
|---|---|
device_code |
Um valor que o Google atribui exclusivamente para identificar o dispositivo que executa o app solicitando
autorização. O usuário autorizará esse dispositivo de outro com recursos de entrada mais avançados. Por exemplo, um usuário pode usar um laptop ou smartphone para autorizar um app executado em uma TV. Nesse caso, o device_code identifica a TV.
Esse código permite que o dispositivo que executa o app determine com segurança se o usuário concedeu ou negou o acesso. |
expires_in |
O período, em segundos, em que device_code e
user_code são válidos. Se, nesse momento, o usuário não concluir o
fluxo de autorização e o dispositivo não pesquisar
para recuperar informações sobre a decisão do usuário, será necessário reiniciar esse processo da etapa 1. |
interval |
O período, em segundos, que seu dispositivo deve aguardar entre solicitações de pesquisa. Por
exemplo, se o valor for 5, o dispositivo enviará uma solicitação de pesquisa ao
servidor de autorização do Google a cada cinco segundos. Veja mais detalhes na etapa 3. |
user_code |
Um valor que diferencia maiúsculas de minúsculas e identifica os escopos aos quais o aplicativo está solicitando acesso. A interface do usuário instruirá o usuário a inserir esse valor em um dispositivo separado com recursos de entrada mais avançados. O Google usa o valor para exibir o conjunto correto de escopos ao solicitar que o usuário conceda acesso ao seu aplicativo. |
verification_url |
Um URL que o usuário precisa acessar, em um dispositivo separado, para inserir a
user_code e conceder ou negar o acesso ao app. Sua interface do usuário também exibirá esse valor. |
O snippet a seguir mostra um exemplo de resposta:
{
"device_code": "4/4-GMMhmHCXhWEzkobqIHGG_EnNYYsAkukHspeYUk9E8",
"user_code": "GQVQ-JKEC",
"verification_url": "https://www.google.com/device",
"expires_in": 1800,
"interval": 5
}
Cota excedida na resposta
Se as solicitações de código do dispositivo excederem a cota associada ao seu ID do cliente, você receberá uma resposta 403 com o seguinte erro:
{
"error_code": "rate_limit_exceeded"
}
Nesse caso, use uma estratégia de espera para reduzir a taxa de solicitações.
Etapa 3: exibir o código do usuário
Exiba o verification_url e o user_code recebidos na etapa 2 para o
usuário. Os dois valores podem conter qualquer caractere para impressão do conjunto de caracteres US-ASCII. O conteúdo
exibido ao usuário precisa instruir o usuário a navegar para o
verification_url em um dispositivo separado e inserir a user_code.
Projete a interface do usuário (IU) com as seguintes regras em mente:
user_code- O
user_codeprecisa ser exibido em um campo que aceite 15 caracteres W e 39. Em outras palavras, se você conseguir exibir o códigoWWWWWWWWWWWWWWWcorretamente, a IU será válida. Recomendamos usar esse valor de string ao testar a forma como ouser_codeé exibido na IU. - O
user_codediferencia maiúsculas de minúsculas e não pode ser modificado, como mudar o caso ou inserir outros caracteres de formatação.
- O
verification_url- O espaço em que você exibe o
verification_urlprecisa ser largo o suficiente para processar uma string de URL com 40 caracteres. - Não modifique o
verification_urlde nenhuma maneira, apenas para remover o esquema de exibição. Se você planeja remover o esquema (por exemplo,https://) do URL por motivos de exibição, verifique se o app pode processar as varianteshttpehttps.
- O espaço em que você exibe o
Etapa 4: fazer uma enquete com o servidor de autorização do Google
Como o usuário usará um dispositivo separado para navegar até o verification_url
e conceder (ou negar) acesso, o dispositivo solicitante não será notificado automaticamente quando o usuário
responder à solicitação de acesso. Por isso, o dispositivo solicitante precisa pesquisar o servidor de autorização do Google para determinar quando o usuário respondeu à solicitação.
O dispositivo solicitante precisa continuar enviando solicitações de pesquisa até receber uma resposta
indicando que o usuário respondeu à solicitação de acesso ou até o device_code
e o user_code recebidos na
etapa 2 expirarem. O interval retornado na etapa 2 especifica a quantidade de tempo, em segundos, de espera entre as solicitações.
O URL do endpoint a ser pesquisado é https://oauth2.googleapis.com/token. A solicitação de pesquisa
contém os seguintes parâmetros:
| Parâmetros | |
|---|---|
client_id |
O ID do cliente do seu aplicativo. Esse valor está no API Console Credentials page. |
client_secret |
A chave secreta do cliente do client_id fornecido. Esse valor está no
API Console
Credentials page. |
device_code |
O device_code retornado pelo servidor de autorização na
etapa 2. |
grant_type |
Defina esse valor como urn:ietf:params:oauth:grant-type:device_code. |
Examples
O snippet a seguir mostra um exemplo de solicitação:
POST /token HTTP/1.1 Host: oauth2.googleapis.com Content-Type: application/x-www-form-urlencoded client_id=client_id& client_secret=client_secret& device_code=device_code& grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code
Este exemplo mostra um comando curl para enviar a mesma solicitação:
curl -d "client_id=client_id&client_secret=client_secret& \
device_code=device_code& \
grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code" \
-H "Content-Type: application/x-www-form-urlencoded" \
/token
Etapa 5: o usuário responde à solicitação de acesso
A imagem a seguir mostra uma página semelhante à que os usuários veem ao navegar para o
verification_url que você exibiu na etapa 3:
Depois de digitar o user_code e, se ainda não tiver feito login,
o usuário verá uma tela de consentimento como a mostrada abaixo:
Etapa 6: processar as respostas às solicitações de pesquisa
O servidor de autorização do Google responde a cada solicitação de pesquisa com uma das seguintes respostas:
Acesso concedido
Se o usuário tiver concedido acesso ao dispositivo (clicando em Allow na tela de consentimento),
a resposta conterá um token de acesso e um token de atualização. Os tokens permitem que o dispositivo acesse APIs do Google em nome do usuário. A propriedade scope na resposta determina quais APIs o dispositivo pode acessar.
Nesse caso, a resposta da API contém os seguintes campos:
| Campos | |
|---|---|
access_token |
O token que seu aplicativo envia para autorizar uma solicitação da API do Google. |
expires_in |
O ciclo de vida restante do token de acesso em segundos. |
refresh_token |
Um token que pode ser usado para receber um novo token de acesso. Os tokens de atualização são válidos até que o usuário revogue o acesso. Observe que os tokens de atualização são sempre retornados para dispositivos. |
scope |
Os escopos de acesso concedidos pelo access_token expressos como uma lista de strings delimitadas por espaços e diferenciando maiúsculas de minúsculas. |
token_type |
O tipo de token retornado. No momento, o valor desse campo é sempre definido como Bearer. |
O snippet a seguir mostra um exemplo de resposta:
{
"access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
"expires_in": 3920,
"scope": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
"token_type": "Bearer",
"refresh_token": "1/xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
}
Os tokens de acesso têm vida útil limitada. Se o aplicativo precisar acessar uma API por um longo período, ele poderá usar o token de atualização para gerar um novo token. Se o aplicativo precisa desse tipo de acesso, ele precisa armazenar o token de atualização para uso posterior.
Acesso negado
Se o usuário se recusar a conceder o acesso ao dispositivo, a resposta do servidor terá um
Código de status de resposta HTTP 403 (Forbidden). A resposta conterá o
seguinte erro:
{
"error": "access_denied",
"error_description": "Forbidden"
}
Autorização pendente
Se o usuário ainda não tiver concluído o fluxo de autorização, o servidor retornará um
Código de status de resposta HTTP 428 (Precondition Required). A resposta
conterá o seguinte erro:
{
"error": "authorization_pending",
"error_description": "Precondition Required"
}
Enquetes com muita frequência
Se o dispositivo enviar solicitações de pesquisa com muita frequência, o servidor retornará um Código de status de resposta HTTP 403 (Forbidden). A resposta conterá o seguinte erro:
{
"error": "slow_down",
"error_description": "Forbidden"
}
Outros erros
O servidor de autorização também retornará erros se a solicitação de pesquisa não tiver parâmetros obrigatórios ou tiver um valor de parâmetro incorreto. Essas solicitações geralmente têm um código de status da resposta HTTP 400
(Bad Request) ou 401 (Unauthorized). Esses erros incluem o seguinte:
| Erro | Código de status HTTP | Descrição |
|---|---|---|
invalid_client |
401 |
O cliente OAuth não foi encontrado. Por exemplo, esse erro ocorrerá se o valor do parâmetro client_id for inválido. |
invalid_grant |
400 |
O valor do parâmetro code é inválido. |
unsupported_grant_type |
400 |
O valor do parâmetro grant_type é inválido. |
Como chamar APIs do Google
Depois que seu aplicativo receber um token de acesso, você poderá usá-lo para fazer chamadas a uma API do Google em nome de uma determinada conta de usuário se os escopos de acesso exigidos pela API tiverem sido concedidos. Para fazer isso, inclua o token de acesso em uma solicitação para a API incluindo um parâmetro de consulta access_token ou um valor Bearer de cabeçalho HTTP Authorization. Quando possível, prefira usar o cabeçalho HTTP, já que as strings de consulta costumam ficar visíveis nos registros do servidor. Na maioria dos casos, você pode usar uma biblioteca de cliente para configurar as chamadas para as APIs do Google (por exemplo, ao chamar a API Drive Files).
Você pode testar todas as APIs do Google e ver os escopos delas no OAuth 2.0 Playground.
Exemplos de HTTP GET
Uma chamada para o endpoint
drive.files (a API Drive Files) usando o cabeçalho HTTP
Authorization: Bearer pode ser semelhante a esta: Observe que você precisa especificar seu próprio token de acesso:
GET /drive/v2/files HTTP/1.1 Host: www.googleapis.com Authorization: Bearer access_token
Esta é uma chamada para a mesma API para o usuário autenticado que usa o parâmetro de string de consulta access_token:
GET https://www.googleapis.com/drive/v2/files?access_token=access_token
Exemplos de curl
É possível testar esses comandos com o aplicativo de linha de comando curl. Veja um exemplo que usa a opção de cabeçalho HTTP (preferencial):
curl -H "Authorization: Bearer access_token" https://www.googleapis.com/drive/v2/files
Ou, como alternativa, a opção de parâmetro da string de consulta:
curl https://www.googleapis.com/drive/v2/files?access_token=access_token
Atualização do token de acesso
Os tokens de acesso expiram periodicamente e se tornam credenciais inválidas para uma solicitação de API relacionada. É possível atualizar um token de acesso sem solicitar a permissão do usuário (inclusive quando ele não está presente) caso tenha solicitado acesso off-line aos escopos associados ao token.
Para atualizar um token de acesso, seu aplicativo envia uma solicitação HTTPS POST
ao servidor de autorização do Google (https://oauth2.googleapis.com/token) que
inclui os seguintes parâmetros:
| Campos | |
|---|---|
client_id |
ID do cliente recebido do API Console. |
client_secret |
Chave secreta do cliente recebida do API Console. |
grant_type |
Conforme definido na especificação do OAuth 2.0, o valor deste campo precisa ser definido como refresh_token. |
refresh_token |
O token de atualização retornado da troca de código de autorização. |
O snippet a seguir mostra um exemplo de solicitação:
POST /token HTTP/1.1 Host: oauth2.googleapis.com Content-Type: application/x-www-form-urlencoded client_id=your_client_id& client_secret=your_client_secret& refresh_token=refresh_token& grant_type=refresh_token
Desde que o usuário não revogue o acesso concedido ao aplicativo, o servidor de token retorna um objeto JSON que contém um novo token de acesso. O snippet a seguir mostra um exemplo de resposta:
{
"access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
"expires_in": 3920,
"scope": "https://www.googleapis.com/auth/drive.metadata.readonly",
"token_type": "Bearer"
}
Há limites para o número de tokens de atualização que serão emitidos: um limite por combinação cliente/usuário e outro por usuário em todos os clientes. Salve tokens de atualização no armazenamento de longo prazo e continue a usá-los, desde que eles permaneçam válidos. Se o aplicativo solicitar muitos tokens de atualização, ele poderá atingir esses limites. Nesse caso, os tokens de atualização mais antigos deixarão de funcionar.
Revogação de token
Em alguns casos, um usuário pode querer revogar o acesso concedido a um aplicativo. Um usuário pode revogar o acesso acessando as Configurações da conta. Para mais informações, consulte a seção Remover o acesso ao site ou app dos sites de terceiros &apps com acesso à sua conta.
Também é possível que um app revogue programaticamente o acesso concedido a ele. A revogação programática é importante nos casos em que um usuário cancela a inscrição, remove um aplicativo ou os recursos da API exigidos por um aplicativo mudam significativamente. Em outras palavras, parte do processo de remoção pode incluir uma solicitação de API para garantir que as permissões concedidas anteriormente ao aplicativo sejam removidas.
Para revogar um token de maneira programática, o aplicativo faz uma solicitação para https://oauth2.googleapis.com/revoke e inclui o token como um parâmetro:
curl -d -X -POST --header "Content-type:application/x-www-form-urlencoded" \
https://oauth2.googleapis.com/revoke?token={token}
O token pode ser de acesso ou de atualização. Se for um token de acesso e tiver um token de atualização correspondente, o token de atualização também será revogado.
Se a revogação for processada, o código de status HTTP da resposta será
200. Para condições de erro, um código de status HTTP 400 é retornado com um código de erro.
Escopos permitidos
O fluxo OAuth 2.0 para dispositivos é compatível apenas com os seguintes escopos:
OpenID Connect, Login do Google
emailopenidprofile
API Drive
https://www.googleapis.com/auth/drive.appdatahttps://www.googleapis.com/auth/drive.file
API YouTube
https://www.googleapis.com/auth/youtubehttps://www.googleapis.com/auth/youtube.readonly