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.

Note: Please choose which OAuth 2.0 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

Implementa la vinculación de cuentas mediante OAuth

Nota: Si estás implementando la vinculación de cuentas para administrar información financiera, ten en cuenta que podrían aplicarse políticas adicionales a tu Acción. La revisión de una Acción con vinculación de cuentas para información financiera puede tardar hasta seis semanas, por lo que debes tener en cuenta ese tiempo cuando planifiques tu programa de lanzamientos. Para facilitar el proceso de revisión, asegúrate de cumplir con las políticas de servicios financieros antes de enviar tu Acción a revisión.

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 Implícito y OAuth.

   

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.
   • Inserta las URL para tus extremos de autorización y de intercambio de tokens.

Nota: Si deseas que tu ID de cliente se envíe como una string codificada en base64, haz clic en la flecha desplegable junto a Configurar tu cliente (opcional) y marca la casilla Google para transmitir el ID de cliente y el secreto a través del encabezado de autenticación básica HTTP.

6. Haz clic en Guardar.

Implementa tu servidor OAuth

Para admitir el flujo implícito de OAuth 2.0, tu servicio pone a disposición un extremo de autorización mediante HTTPS. Este extremo es responsable de autenticar y obtener el consentimiento de los usuarios para el acceso a los datos. El extremo de autorización presenta una IU de acceso a los usuarios que aún no accedieron y registra su consentimiento para el acceso solicitado.

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

Una sesión típica de flujo implícito de OAuth 2.0 que inicia Google tiene el siguiente flujo:

1. Google abrirá tu extremo de autorización en el navegador del usuario. El usuario accede 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 lo ha hecho.
2. Tu servicio crea un token de acceso y lo muestra a Google. Para ello, redirecciona el navegador del usuario a Google con el token de acceso adjunto a la solicitud.
3. Google llama a las APIs de tu servicio y adjunta el token de acceso a cada solicitud. El servicio verifica que el token de acceso otorgue a Google autorización para acceder a la API y, luego, completa la llamada a la API.

Cómo controlar solicitudes de autorización

Cuando tu Acción necesita realizar una vinculación de cuentas a través de un flujo implícito de OAuth 2.0, 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 que asignaste a Google.
redirect_uri	La URL a la que envías la respuesta a esta solicitud.
state	Es un valor de contabilidad que se pasa a Google sin cambios en el URI de redireccionamiento.
response_type	Es el tipo de valor que se muestra en la respuesta. Para el flujo implícito de OAuth 2.0, el tipo de respuesta siempre es token.

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

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

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

1. Verifica los valores client_id y redirect_uri para evitar otorgar acceso a apps cliente no deseadas o mal configuradas:

   • Confirma que el client_id coincida con el ID de cliente que asignaste a Google.
   • Confirma que la URL que especifica el parámetro redirect_uri tenga el siguiente formato:

     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.

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

3. Genera un token de acceso que Google usará para acceder a tu API. El token de acceso puede ser cualquier valor de string, pero debe representar de manera inequívoca al usuario y al cliente para el que se trata el token, y no debe ser adivinable.

4. Envía una respuesta HTTP que redireccione el navegador del usuario a la URL que especifica el parámetro redirect_uri. Incluye todos los siguientes parámetros en el fragmento de URL:

   • access_token: Es el token de acceso que acabas de generar.
   • token_type: Es la cadena bearer.
   • state: Es el valor del estado sin modificar de la solicitud original. El siguiente es un ejemplo de la URL resultante:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

El controlador de redireccionamiento de OAuth 2.0 de Google recibirá el token de acceso y confirmará que el valor state no cambió. Después de que Google haya obtenido un token de acceso para tu servicio, lo adjuntará a las llamadas posteriores a tu acción como parte de AppRequest.

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

Advertencia: No proporciones a los usuarios una solicitud de vinculación de cuenta obligatoria al comienzo de la conversación con tu acción. En su lugar, proporciona a los usuarios no autenticados un flujo de invitado para mostrar cómo funciona tu acción y, luego, solicita la vinculación de cuentas solo si es necesario para continuar. Si los usuarios abandonan la Acción de manera constante debido a problemas de vinculación de cuentas, Google no la promocionará de forma activa, lo que podría disminuir su tráfico de usuarios.

Nota: Debes usar Actions Builder para compilar una acción que implemente la vinculación de cuentas.

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.