Vinculación de cuentas con OAuth

El tipo de vinculación de OAuth es compatible con dos flujos de OAuth 2.0 estándar de la industria: los flujos de código implícito y de autorización.

In the implicit code flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from the Assistant to your Action.

In the authorization code flow, you need two endpoints:

  • The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
  • The token exchange endpoint, which is responsible for two types of exchanges:
    1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
    2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

Implementa la vinculación de cuentas mediante OAuth

Configura el proyecto

Si deseas configurar tu proyecto para que use la vinculación de OAuth, sigue estos pasos:

  1. Abre la Consola de Actions y selecciona el proyecto que deseas usar.
  2. Haz clic en la pestaña Desarrollo y elige Vinculación de cuentas.
  3. Habilita el interruptor que se encuentra junto a Vinculación de cuentas.
  4. En la sección Creación de cuenta, selecciona No, solo quiero permitir la creación de cuentas en mi sitio web.

  5. En Tipo de vinculación, selecciona OAuth y Código de autorización.

  6. En Información del cliente (Client information), haz lo siguiente:

    • Asigna un valor al ID de cliente emitido por tus acciones a Google para identificar las solicitudes que provienen de Google.
    • Toma nota del valor del ID de cliente emitido por Google para tus acciones.
    • Inserta las URL para tus extremos de autorización y de intercambio de tokens.
  1. Haz clic en Guardar.

Implementa tu servidor OAuth

Una implementación del servidor OAuth 2.0 del flujo de código de autorización consta de dos extremos, que tu servicio pone a disposición a través de HTTPS. El primer extremo es el extremo de autorización, que es responsable de encontrar u obtener el consentimiento de los usuarios para acceder a los datos. El extremo de autorización presenta una solicitud para los usuarios que aún no hayan accedido y que registran su consentimiento solicitaron acceso. El segundo extremo es el extremo de intercambio de tokens, que es se usan para obtener cadenas encriptadas llamadas tokens que autorizan al usuario para acceder a tu servicio.

Cuando tu acción necesita llamar a una de las APIs de tu servicio, Google usa estas de extremo a fin de obtener permiso de los usuarios para llamar a estas APIs en sus nombre.

La sesión del flujo de código de autorización de OAuth 2.0 que inicia Google tiene el siguiente flujo:

  1. Google abre el extremo de autorización en el navegador del usuario. Si el flujo que se iniciara en un dispositivo solo de voz para una Acción, Google transferiría el ejecución a un teléfono.

  2. El usuario accede a su cuenta (si aún no lo ha hecho) y le otorga permiso a Google para: acceder a sus datos con tu API si aún no han otorgado permiso.

  3. Tu servicio crea un código de autorización y lo devuelve a Google mediante redireccionar el navegador del usuario de vuelta a Google con el código de autorización que se adjuntan a la solicitud.

  4. Google envía el código de autorización a tu extremo de intercambio de token, que verifica la autenticidad del código y devuelve un token de acceso y un token de actualización. El token de acceso es un token de corta duración que acepta como credenciales para acceder a las APIs. El token de actualización es de larga duración token que Google puede almacenar y usar para adquirir nuevos tokens de acceso cuando y vencer.

  5. Después de que el usuario completa el flujo de vinculación de cuentas, cada de entrega enviada desde el Asistente a tu webhook de entrega token de acceso.

Maneja solicitudes de autorización

Cuando tu acción necesite vincular cuentas mediante un código de autorización de OAuth 2.0 flujo, Google envía al usuario a tu extremo de autorización con una solicitud que incluye los siguientes parámetros:

Parámetros del extremo de autorización
client_id El ID de cliente de Google que registraste en Google.
redirect_uri La URL a la que envías la respuesta a esta solicitud.
state Un valor de contabilidad que se devuelve a Google sin modificar en el URI de redireccionamiento.
scope Opcional: Un conjunto de strings de alcance delimitado por espacios que especifica la datos para los que Google solicita autorización.
response_type La string code.

Por ejemplo, si tu extremo de autorización está disponible en https://myservice.example.com/auth, una solicitud podría verse así:

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

Para que tu extremo de autorización controle las solicitudes de acceso, sigue estos pasos:

  1. Verifica que client_id coincida con el ID de cliente de Google con el que te registraste Google y que redirect_uri coincida con la URL de redireccionamiento que proporciona Google para tu servicio. Estas verificaciones son importantes para evitar que se otorgue acceso a apps cliente no deseadas o configuradas incorrectamente.

    Si admites varios flujos de OAuth 2.0, también confirma que el response_type es code.

  2. Verifica si el usuario accedió a tu servicio. Si el usuario no accedió, completar el flujo de acceso o registro del servicio.

  3. Genera un código de autorización que Google usará para acceder a tu API. El código de autorización puede ser cualquier valor de cadena, pero debe ser representar al usuario, al cliente al que pertenece el token y el vencimiento del código el tiempo y que no debe ser adivinable. Por lo general, se emiten autorizaciones los códigos que vencen después de unos 10 minutos.

  4. Confirma que la URL especificada en el parámetro redirect_uri tiene la siguiente forma: 

    https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
    YOUR_PROJECT_ID es el ID que se encuentra en la página Configuración del proyecto de la Consola de Actions.

  5. Redireccionar el navegador del usuario a la URL especificada por el Parámetro redirect_uri. Incluya el código de autorización que que acabas de generar y el valor de estado original, sin modificar, cuando redireccionas Agregando los parámetros code y state. A continuación, se muestra un ejemplo de la URL resultante: 

    https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

Controla las solicitudes de intercambio de tokens

El extremo de intercambio de tokens de tu servicio es responsable de dos tipos de tokens intercambios:

  • Intercambia códigos de autorización por tokens de acceso y tokens de actualización
  • Intercambia tokens de actualización por tokens de acceso

Las solicitudes de intercambio de tokens incluyen los siguientes parámetros:

Parámetros del extremo de intercambio de tokens
client_id Una cadena que identifica el origen de la solicitud como Google. Esta cadena debe estar registrados en tu sistema como el identificador único de Google.
client_secret Es una cadena secreta que registraste en Google para tu servicio.
grant_type El tipo de token que se intercambia. Cualquiera de las siguientes opciones authorization_code o refresh_token.
code Cuando sea grant_type=authorization_code, el código que Google que se reciban desde el extremo de acceso o intercambio de tokens.
redirect_uri Cuando es grant_type=authorization_code, este parámetro es el URL utilizada en la solicitud de autorización inicial.
refresh_token Cuando sea grant_type=refresh_token, el token de actualización de Google recibidos desde tu extremo de intercambio de tokens.
Intercambia códigos de autorización por tokens de acceso y tokens de actualización

Después de que el usuario accede y tu extremo de autorización muestra una autorización de corta duración código a Google, Google envía una solicitud a tu extremo de intercambio de token para el código de autorización para un token de acceso y un token de actualización.

Para estas solicitudes, el valor de grant_type es authorization_code, y el valor code es el valor del código de autorización que le otorgaste a Google. El siguiente es un ejemplo de una solicitud para intercambiar un código de autorización por un un token de acceso y un token de actualización:

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

Para intercambiar códigos de autorización por un token de acceso y un token de actualización, tu El extremo de intercambio de tokens responde a las solicitudes POST mediante los siguientes pasos:

  1. Verifica que client_id identifique el origen de la solicitud como uno autorizado. y de que client_secret coincida con el valor esperado.
  2. Verifica lo siguiente:
    • El código de autorización es válido y no está vencido, y el cliente especificado en la solicitud coincide con el ID de cliente asociado al código de autorización.
    • La URL especificada por el parámetro redirect_uri es idéntica según el valor que se usó en la solicitud de autorización inicial.
  3. Si no puedes verificar todos los criterios anteriores, devuelve una solicitud HTTP Error 400 de solicitud incorrecta con {"error": "invalid_grant"} como cuerpo.
  4. De lo contrario, con el ID de usuario del código de autorización, genera una actualización y uno de acceso. Estos tokens pueden ser cualquier valor de cadena, pero deben representar de forma única al usuario y al cliente para el que es el token, y estos no deben no se puedan adivinar. Para los tokens de acceso, registra también la fecha y hora de vencimiento del token (por lo general, una hora después de que se emite el token). Los tokens de actualización no vencen.
  5. Muestra el siguiente objeto JSON en el cuerpo de la respuesta HTTPS: 
    {
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"refresh_token": "REFRESH_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}

Google almacena el token de acceso y el token de actualización para el usuario y registra el vencimiento del token de acceso. Cuando vence el token de acceso, Google usa la actualización para obtener un token de acceso nuevo desde el extremo de intercambio del token.

Intercambia tokens de actualización por tokens de acceso

Cuando vence un token de acceso, Google envía una solicitud a tu extremo de intercambio de token para intercambiar un token de actualización por un token de acceso nuevo.

Para estas solicitudes, el valor de grant_type es refresh_token, y el valor de refresh_token es el valor del token de actualización que le otorgaste a Google anteriormente. El siguiente es un ejemplo de una solicitud para intercambiar un token de actualización por un token de acceso:

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

Para intercambiar un token de actualización por un token de acceso, el extremo de intercambio del token responde a las solicitudes POST ejecutando los siguientes pasos:

  1. Verifica que client_id identifique el origen de la solicitud como Google, y que el client_secret coincida con la valor.
  2. Verifica que el token de actualización sea válido y que el ID de cliente especificado en la solicitud coincida con el ID de cliente asociado con el token de actualización.
  3. Si no puedes verificar todos los criterios anteriores, devuelve una solicitud HTTP Error 400 de solicitud incorrecta con {"error": "invalid_grant"} como cuerpo.
  4. De lo contrario, usa el ID de usuario del token de actualización para generar un permiso token. Estos tokens pueden ser cualquier valor de cadena, pero deben representar de manera única el usuario y el cliente al que corresponde el token, y que no se deben poder adivinar. Para los tokens de acceso, registra también la fecha y hora de vencimiento del token (por lo general, una hora después de que se emite el token).
  5. Devuelve el siguiente objeto JSON en el cuerpo del protocolo HTTPS respuesta: 
    {
"token_type": "Portador",
“access_token”: “ACCESS_TOKEN”,
“expires_in”: SECONDS_TO_EXPIRATION
}.

Diseñar la interfaz de usuario de voz para el flujo de autenticación

Comprueba si el usuario está verificado y comienza el flujo de vinculación de cuentas

  1. Abre tu proyecto de Actions Builder en la Consola de Actions.
  2. Crea una escena nueva para comenzar a vincular cuentas en tu acción:
    1. Haz clic en Scenes.
    2. Haz clic en el ícono de agregar (+) para agregar una escena nueva.
  3. En la escena recién creada, haz clic en el ícono de agregar para Conditions.
  4. Agrega una condición que verifique si el usuario asociado con la conversación es un usuario verificado. Si la verificación falla, tu Acción no podrá realizar la vinculación de cuentas durante la conversación y debería volver a proporcionar acceso a la funcionalidad que no requiera la vinculación de cuentas.
    1. En el campo Enter new expression, en Condición, ingresa la siguiente lógica: user.verificationStatus != "VERIFIED"
    2. En Transición, selecciona una escena que no requiera la vinculación de una cuenta o una que sea el punto de entrada a la funcionalidad solo para invitados.

  1. Haz clic en el ícono de agregar para Conditions.
  2. Agrega una condición para activar un flujo de vinculación de cuentas si el usuario no tiene una identidad asociada.
    1. En el campo Enter new expression, en Condición, ingresa la siguiente lógica: user.verificationStatus == "VERIFIED"
    2. En Transition, selecciona la escena del sistema Account Linking.
    3. Haz clic en Guardar.

Después de guardar, se agrega a tu proyecto una nueva escena del sistema de vinculación de cuentas llamada <SceneName>_AccountLinking.

Personaliza la escena de vinculación de cuentas

  1. En Scenes, selecciona la escena del sistema de vinculación de cuentas.
  2. Haz clic en Send prompt y agrega una oración breve para describirle al usuario por qué la acción necesita acceder a su identidad (por ejemplo, "Para guardar tus preferencias").
  3. Haz clic en Guardar.

  1. En Condiciones, haz clic en Si el usuario completa la vinculación de cuentas correctamente.
  2. Configura cómo debe proceder el flujo si el usuario acepta vincular su cuenta. Por ejemplo, llama al webhook para procesar cualquier lógica empresarial personalizada que se requiera y realizar la transición a la escena de origen.
  3. Haz clic en Guardar.

  1. En Condiciones, haz clic en Si el usuario cancela o descarta la vinculación de cuentas.
  2. Configura cómo debe proceder el flujo si el usuario no acepta vincular su cuenta. Por ejemplo, envía un mensaje de confirmación y redirecciona a escenas que proporcionen funcionalidades que no requieren la vinculación de cuentas.
  3. Haz clic en Guardar.

  1. En Condiciones, haz clic en Si se produce un error de sistema o red.
  2. Configura cómo debe proceder el flujo si el flujo de vinculación de cuentas no se puede completar debido a errores del sistema o de la red. Por ejemplo, envía un mensaje de confirmación y redirecciona a escenas que proporcionen funcionalidades que no requieren la vinculación de cuentas.
  3. Haz clic en Guardar.

Controla las solicitudes de acceso a los datos

Si la solicitud de Asistente contiene un token de acceso, primero verifica que el token sea válido (y no haya vencido) y, luego, recupera la cuenta de usuario asociada de tu base de datos.