As ações de conversa foram descontinuadas em 13 de junho de 2023. Para mais informações, consulte Desativação do recurso Ações de conversa.

Esta página foi traduzida pela API Cloud Translation.

Vinculação de contas com a vinculação "simplificada" do Login do Google com base em OAuth

O tipo de vinculação simplificada do Login do Google com base em OAuth adiciona o Login do Google à vinculação de contas com base em OAuth. Isso fornece vinculação baseada em voz integrada para usuários do Google e, ao mesmo tempo, permite a vinculação de contas para usuários que se registraram no serviço com uma identidade que não é do Google.

Esse tipo de vinculação começa com o Login do Google, que permite verificar se as informações do perfil do Google do usuário existem no seu sistema. Se as informações do usuário não forem encontradas no sistema, um fluxo padrão do OAuth será iniciado. O usuário também pode optar por criar uma nova conta com as informações do perfil do Google dele.

**Figura 1**: depois que a Ação tiver acesso ao perfil do Google do usuário, use-o para encontrar uma correspondência para o usuário no sistema de autenticação.

Para fazer a vinculação de contas com o tipo de vinculação simplificada, siga estas etapas gerais:

Primeiro, peça que o usuário dê consentimento para acessar o perfil do Google.
Use as informações no perfil para identificar o usuário.
Se não encontrar uma correspondência para o usuário do Google no sistema de autenticação, o fluxo continuará dependendo se você configurou o projeto do Actions no Console do Actions para permitir a criação de contas de usuário por voz ou apenas no seu site.
- Se você permitir a criação de conta por voz, valide o token de ID recebido do Google. Então, você poderá criar um usuário com base nas informações de perfil contidas no token de ID.
- Se você não permitir a criação de contas por voz, o usuário será transferido para um navegador em que ele poderá carregar sua página de autorização e concluir o fluxo de criação.

Se você permitir a criação de contas por voz e não encontrar uma correspondência para o
perfil do Google no seu sistema de autenticação, será necessário
validar o token de ID recebido do Google. Então, você poderá criar um usuário com base nas informações de perfil contidas no token de ID.
Se você não permitir a criação de contas de usuário por voz, o usuário será
transferido para um navegador em que poderá carregar sua página de autorização
e concluir o fluxo. — **Figura 2**. Uma representação visual do fluxo de OAuth e Login do Google quando as informações de um usuário não são encontradas no seu sistema.

Suporte à criação de contas por voz

Se você permitir a criação de contas de usuário por voz, o Google Assistente vai perguntar ao usuário se ele quer fazer o seguinte:

Criar uma nova conta no seu sistema usando as informações da Conta do Google dele ou
Faça login no seu sistema de autenticação com uma conta diferente, se ele já tiver uma conta que não seja do Google.

Permitir a criação de contas por voz é recomendado se você quiser minimizar o atrito do fluxo de criação de contas. O usuário só precisa sair do fluxo de voz se quiser fazer login usando uma conta que não seja do Google.

Não permitir a criação de conta por voz

Se você não permitir a criação de contas de usuário por voz, o Google Assistente vai abrir o URL do site fornecido para a autenticação. Se a interação estiver acontecendo em um dispositivo sem tela, o Google Assistente vai direcionar o usuário a um smartphone para continuar o fluxo de vinculação da conta.

É recomendável não permitir a criação se:

Você não quer permitir que usuários que tenham contas que não sejam do Google criem uma nova conta de usuário e que vinculem as contas de usuário existentes no seu sistema de autenticação. Por exemplo, se você oferecer um programa de fidelidade, convém garantir que o usuário não perca os pontos acumulados na conta atual.
Você precisa ter controle total do fluxo de criação da conta. Por exemplo, você poderá impedir a criação se precisar mostrar seus Termos de Serviço ao usuário durante a criação da conta.

Implementar a vinculação simplificada do Login do Google com base em OAuth

As contas estão vinculadas aos fluxos do OAuth 2.0 padrão do setor. O Actions on Google oferece suporte aos fluxos implícitos e de código de autorização.

No fluxo de código implícito, o Google abre o endpoint de autorização no navegador do usuário. Após o login, você retorna um token de acesso de longa duração para o Google. Esse token de acesso agora está incluído em todas as solicitações enviadas do Assistente para sua ação.

No fluxo do código de autorização, você precisa de dois endpoints:

O endpoint de autorização, responsável por apresentar a IU de login aos usuários que ainda não fizeram login e registrar o consentimento para o acesso solicitado na forma de um código de autorização de curta duração.
O endpoint de troca de token, que é responsável por dois tipos de trocas:
1. troca um código de autorização por um token de atualização de longa duração e um token de acesso de curta duração. Essa troca acontece quando o usuário passa pelo fluxo de vinculação da conta.
2. Troca um token de atualização de longa duração por um token de acesso de curta duração. Essa troca acontece quando o Google precisa de um novo token de acesso porque ele expirou.

Embora o fluxo do código implícito seja mais simples de implementar, o Google recomenda que os tokens de acesso emitidos usando o fluxo implícito nunca expirem, porque o uso do token com o fluxo implícito força o usuário a vincular a conta novamente. Se você precisar da validade do token por motivos de segurança, considere o uso do fluxo do código de autenticação.

Configurar o projeto

Para configurar seu projeto para usar a vinculação simplificada, siga estas etapas:

Abra o Console do Actions e selecione o projeto que você quer usar.
Clique na guia Desenvolver e escolha Vinculação de contas.
Ative a chave ao lado de Vinculação de contas.
Na seção Criação de conta, selecione Sim.
Em Tipo de vinculação, selecione OAuth e Login do Google e Implícito.
Em Informações do cliente, faça o seguinte:
- Atribua um valor ao ID do cliente emitido pelas suas ações para o Google para identificar solicitações do Google.
- Insira os URLs dos endpoints de autorização e de troca de tokens.
Clique em Salvar.

Implementar o servidor OAuth

Para oferecer suporte ao fluxo implícito do OAuth 2.0, seu serviço disponibiliza um endpoint de autorização por HTTPS. Esse endpoint é responsável por autenticar e receber o consentimento dos usuários para acessar os dados. O endpoint de autorização apresenta uma interface de login para os usuários que ainda não estão conectados e registra o consentimento para o acesso solicitado.

Quando a ação precisa chamar uma das APIs autorizadas do serviço, o Google usa esse endpoint para receber permissão dos usuários para chamar essas APIs em nome deles.

Uma sessão de fluxo implícito do OAuth 2.0 típica iniciada pelo Google tem este fluxo:

O Google abre seu endpoint de autorização no navegador do usuário. O usuário faz login, caso ainda não tenha feito isso, e concede ao Google permissão para acessar os dados com sua API, caso ainda não tenha concedido essa permissão.
O serviço cria um token de acesso e o retorna ao Google redirecionando o navegador do usuário de volta para o Google com o token de acesso anexado à solicitação.
O Google chama as APIs do seu serviço e anexa o token de acesso a cada solicitação. Seu serviço verifica se o token de acesso concede ao Google autorização para acessar a API e, em seguida, conclui a chamada de API.

Processar solicitações de autorização

Quando sua Ação precisa realizar a vinculação de contas por um fluxo implícito do OAuth 2.0, o Google envia o usuário para o endpoint de autorização com uma solicitação que inclui os seguintes parâmetros:

Parâmetros do endpoint de autorização
`client_id`	O ID do cliente que você atribuiu ao Google.
`redirect_uri`	O URL para onde você envia a resposta para a solicitação.
`state`	Um valor de registro que é retornado ao Google inalterado no URI de redirecionamento.
`response_type`	O tipo de valor a ser retornado na resposta. Para o fluxo implícito do OAuth 2.0, o tipo de resposta é sempre `token`.

Por exemplo, se o endpoint de autorização estiver disponível em https://myservice.example.com/auth, uma solicitação poderá ter esta aparência:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token

Para que o endpoint de autorização processe solicitações de login, siga estas etapas:

Verifique os valores client_id e redirect_uri para evitar a concessão de acesso a apps cliente não intencionais ou configurados incorretamente:
- Confirme se o client_id corresponde ao ID do cliente atribuído ao Google.
- Confirme se o URL especificado pelo parâmetro redirect_uri tem o seguinte formato:
```
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
```
  YOUR_PROJECT_ID é o ID encontrado na página Configurações do projeto do Console do Actions.
Verifique se o usuário está conectado ao serviço. Se o usuário não tiver feito login, conclua o fluxo de inscrição ou login do seu serviço.
Gere um token de acesso que o Google usará para acessar sua API. O token de acesso pode ser qualquer valor de string, mas precisa representar exclusivamente o usuário e o cliente ao qual o token se destina e não pode ser adivinhado.
Envie uma resposta HTTP que redirecione o navegador do usuário para o URL especificado pelo parâmetro redirect_uri. Inclua todos os parâmetros a seguir no fragmento de URL:
- access_token: o token de acesso que você acabou de gerar.
- token_type: a string bearer.
- state: o valor de estado não modificado da solicitação original. Veja a seguir um exemplo do URL resultante:
```
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
```

O gerenciador de redirecionamento do OAuth 2.0 do Google receberá o token de acesso e confirmará se o valor state não foi alterado. Depois que o Google receber um token de acesso para o serviço, ele o anexará às chamadas subsequentes para sua ação como parte do AppRequest.

Handle automatic linking

After the user gives your Action consent to access their Google profile, Google sends a request that contains a signed assertion of the Google user's identity. The assertion contains information that includes the user's Google Account ID, name, and email address. The token exchange endpoint configured for your project handles that request.

If the corresponding Google account is already present in your authentication system, your token exchange endpoint returns a token for the user. If the Google account doesn't match an existing user, your token exchange endpoint returns a user_not_found error.

The request has the following form:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES

Your token exchange endpoint must be able to handle the following parameters:

Token endpoint parameters
`grant_type`	The type of token being exchanged. For these requests, this parameter has the value `urn:ietf:params:oauth:grant-type:jwt-bearer`.
`intent`	For these requests, the value of this parameter is `get`.
`assertion`	A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address.
`consent_code`	Optional: When present, a one-time code that indicates that the user has granted consent for your Action to access the specified scopes.
`scope`	Optional: Any scopes you configured Google to request from users.

When your token exchange endpoint receives the linking request, it should do the following:

Validar e decodificar a declaração do JWT

É possível validar e decodificar a declaração do JWT usando uma biblioteca de decodificação de JWT para sua linguagem. Use as chaves públicas do Google (disponíveis no formato JWK ou PEM) para verificar a assinatura do token.

Quando decodificada, a declaração do JWT é semelhante ao seguinte exemplo:

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "locale": "en_US"
}

Além de verificar a assinatura do token, confira se o emissor da declaração (campo iss) é https://accounts.google.com e se o público (campo aud) é o ID do cliente atribuído à sua ação.

Check if the Google account is already present in your authentication system

Check whether either of the following conditions are true:

The Google Account ID, found in the assertion's sub field, is in your user database.
The email address in the assertion matches a user in your user database.

If either condition is true, the user has already signed up and you can issue an access token.

If neither the Google Account ID nor the email address specified in the assertion matches a user in your database, the user hasn't signed up yet. In this case, your token exchange endpoint should reply with a HTTP 401 error, that specifies error=user_not_found, as in the following example:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"user_not_found",
}

When Google receives the 401 error response with a user_not_found error, Google calls your token exchange endpoint with the value of the intent parameter set to create and sending an ID token that contains the user's profile information with the request.

Processar a criação de contas pelo Login do Google

Quando um usuário precisa criar uma conta no seu serviço, o Google faz uma solicitação ao endpoint de troca de token que especifica intent=create, como no exemplo a seguir:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]

O parâmetro assertion contém um JSON Web Token (JWT) que fornece uma declaração assinada da identidade do usuário do Google. O JWT tem informações que incluem o ID, o nome e o endereço de e-mail da Conta do Google do usuário. Você pode usá-los para criar uma nova conta no seu serviço.

Para responder a solicitações de criação de conta, seu endpoint de troca de token precisa fazer o seguinte:

Validar e decodificar a declaração do JWT

Quando decodificada, a declaração do JWT é semelhante ao seguinte exemplo:

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "locale": "en_US"
}

Validar as informações do usuário e criar uma nova conta

Verifique se uma das condições a seguir é verdadeira:

O ID da Conta do Google, encontrado no campo sub da declaração, está no banco de dados do usuário.
O endereço de e-mail na declaração corresponde a um usuário no seu banco de dados de usuários.

Se uma das condições for verdadeira, solicite que o usuário vincule a conta atual à Conta do Google respondendo à solicitação com um erro HTTP 401, especificando error=linking_error e o endereço de e-mail do usuário como login_hint, como no exemplo a seguir:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

Se nenhuma das condições for verdadeira, crie uma nova conta de usuário com as informações fornecidas no JWT. Contas novas geralmente não têm uma senha definida. Recomendamos que você adicione o Login do Google em outras plataformas para permitir que os usuários façam login pelo Google em todas as plataformas do seu aplicativo. Outra opção é enviar um link por e-mail para o usuário que inicie o fluxo de recuperação de senha. Com isso, o usuário poderá definir uma senha para fazer login em outras plataformas.

Quando a criação for concluída, emita um token de acesso . Em seguida, retorne os valores em um objeto JSON no corpo da resposta HTTPS, como no exemplo a seguir:

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",
  
  "expires_in": SECONDS_TO_EXPIRATION
}

Projetar a interface do usuário de voz para o fluxo de autenticação

Conferir se o usuário foi verificado e iniciar o fluxo de vinculação da conta

Abra seu projeto do Actions Builder no Actions Console.
Crie um novo cenário para começar a vinculação da conta na sua Ação:
1. Clique em Cenas.
2. Clique no ícone add (+) para adicionar uma nova cena.
No cenário recém-criado, clique no ícone de adição para Condições.
Adicione uma condição que verifica se o usuário associado à conversa é um usuário verificado. Se a verificação falhar, a Ação não poderá fazer a vinculação da conta durante a conversa e vai voltar a fornecer acesso a recursos que não exijam a vinculação de conta.
1. No campo Enter new expression em Condição, insira a seguinte lógica: user.verificationStatus != "VERIFIED"
2. Em Transição, selecione uma cena que não exija vinculação de conta ou uma cena que seja o ponto de entrada para a funcionalidade exclusiva para convidados.

Clique no ícone de adição para Condições.
Adicione uma condição para acionar um fluxo de vinculação de conta se o usuário não tiver uma identidade associada.
1. No campo Enter new expression em Condição, insira a seguinte lógica: user.verificationStatus == "VERIFIED"
2. Em Transição, selecione a cena do sistema Vinculação de contas.
3. Clique em Salvar.

Depois de salvar, uma nova cena do sistema de vinculação de contas chamada <SceneName>_AccountLinking será adicionada ao projeto.

Personalizar o cenário de vinculação da conta

Em Scenes, selecione a cena do sistema de vinculação de contas.
Clique em Enviar solicitação e adicione uma frase curta para descrever ao usuário por que a ação precisa acessar a identidade dele (por exemplo, "Para salvar suas preferências").
Clique em Salvar.

Em Condições, clique em Se o usuário concluir a vinculação da conta.
Configure como o fluxo deve proceder se o usuário concordar em vincular a conta. Por exemplo, chame o webhook para processar qualquer lógica de negócios personalizada necessária e fazer a transição de volta para a cena de origem.
Clique em Salvar.

Em Condições, clique em Se o usuário cancelar ou dispensar a vinculação da conta.
Configure como o fluxo deve proceder se o usuário não concordar em vincular a conta. Por exemplo, envie uma mensagem de confirmação e redirecione para cenas que fornecem funcionalidades que não exigem vinculação de conta.
Clique em Salvar.

Em Condições, clique em Se ocorrer um erro de sistema ou rede.
Configure como o fluxo vai proceder se não for possível concluir o fluxo de vinculação da conta devido a erros no sistema ou na rede. Por exemplo, envie uma mensagem de confirmação e redirecione para cenas que fornecem funcionalidades que não exigem vinculação de conta.
Clique em Salvar.

Processar solicitações de acesso a dados

Se a solicitação do Google Assistente contiver um token de acesso, verifique primeiro se o token de acesso é válido e não expirou. Em seguida, recupere a conta do usuário associada ao token no banco de dados da conta de usuário.