Vinculação de contas com o OAuth (Dialogflow)

O tipo de vinculação OAuth oferece suporte a dois fluxos de OAuth 2.0 padrão do setor: os fluxos de código implícito e 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.

Observação: escolha qual fluxo OAuth2 você quer implementar. Se necessário, o conteúdo deste guia será atualizado para se adaptar à sua escolha.

Código de autenticação Fluxo implícito

Implementar a vinculação de conta OAuth

Observação: se você estiver implementando a vinculação de contas para lidar com informações financeiras, outras políticas poderão ser aplicadas à sua Ação. Pode levar até seis semanas para revisar uma Ação com vinculação de conta para informações financeiras. Portanto, considere esse tempo ao planejar a programação de lançamento. Para facilitar o processo de análise, obedeça às políticas de serviços financeiros antes de enviar sua ação para análise.

Configurar o projeto

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

1. Abra o Console do Actions e selecione o projeto que você quer usar.
2. Clique na guia Desenvolver e escolha Vinculação de contas.
3. Ative a chave ao lado de Vinculação de contas.
4. Na seção Criação de conta, selecione Não, quero permitir apenas a criação de contas no meu site.

5. Em Tipo de vinculação, selecione OAuth e Implícito.

   

6. Em Informações do cliente:

   • 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.

Observação :se você quiser que o ID do cliente seja enviado como uma string codificada em base64, clique na seta suspensa ao lado de Configurar seu cliente (opcional) e marque a caixa O Google vai transmitir o clientID e o secret por meio do cabeçalho de autenticação HTTP básico.

6. 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:

1. 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.
2. 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.
3. 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 a Ação precisa realizar a vinculação de contas por um fluxo implícito do OAuth2, 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:

1. 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.

2. 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.

3. 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.

4. 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.

Iniciar o fluxo de autenticação

Aviso: não forneça um aviso obrigatório de vinculação de conta aos usuários no início da conversa com a Ação. Em vez disso, forneça um fluxo de convidado aos usuários não autenticados para mostrar como a Ação funciona e só peça a vinculação de conta se for necessário continuar. Se os usuários estiverem saindo da ação de forma consistente devido a problemas de vinculação de conta, o Google não a promoverá ativamente, o que pode diminuir o tráfego de usuários.

Use a intent auxiliar de login na conta para iniciar o fluxo de autenticação. Os snippets de código a seguir descrevem como enviar uma resposta no Dialogflow e no SDK do Actions para usar esse auxiliar.

O Dialogflow:

Node.js

const {dialogflow, SignIn} = require('actions-on-google');
const app = dialogflow({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('Start Signin', (conv) => {
  conv.ask(new SignIn('To get your account details'));
});

Java

@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

JSON

{
  "payload": {
    "google": {
      "expectUserResponse": true,
      "richResponse": {
        "items": [
          {
            "simpleResponse": {
              "textToSpeech": "PLACEHOLDER"
            }
          }
        ]
      },
      "userStorage": "{\"data\":{}}",
      "systemIntent": {
        "intent": "actions.intent.SIGN_IN",
        "data": {
          "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
          "optContext": "To get your account details"
        }
      }
    }
  },
  "outputContexts": [
    {
      "name": "/contexts/_actions_on_google",
      "lifespanCount": 99,
      "parameters": {
        "data": "{}"
      }
    }
  ]
}

SDK do Actions:

Node.js

const {actionssdk, SignIn} = require('actions-on-google');
const app = actionssdk({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('actions.intent.TEXT', (conv) => {
  conv.ask(new SignIn('To get your account details'));
});

Java

@ForIntent("actions.intent.TEXT")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

JSON

{
  "expectUserResponse": true,
  "expectedInputs": [
    {
      "inputPrompt": {
        "richInitialPrompt": {
          "items": [
            {
              "simpleResponse": {
                "textToSpeech": "PLACEHOLDER"
              }
            }
          ]
        }
      },
      "possibleIntents": [
        {
          "intent": "actions.intent.SIGN_IN",
          "inputValueData": {
            "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
            "optContext": "To get your account details"
          }
        }
      ]
    }
  ],
  "conversationToken": "{\"data\":{}}",
  "userStorage": "{\"data\":{}}"
}

Processar solicitações de acesso a dados

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