Te damos la bienvenida al Centro para desarrolladores de Google Home, el nuevo destino para aprender a desarrollar acciones de casa inteligente. Nota: Seguirás compilando acciones en la Consola de Actions.

Se usó la API de Cloud Translation para traducir esta página.

Implementa un servidor de OAuth 2.0

Cada acción smart home debe incluir un mecanismo para la autenticación de usuarios.

La autenticación te permite vincular las credenciales Cuentas de Google con cuentas de usuario en tu sistema de autenticación. Esto te permite identificar a tus usuarios tu entrega recibe un intent de casa inteligente. La casa inteligente de Google solo admite OAuth con un de código de autorización.

En esta página, se describe cómo configurar tu servidor de OAuth 2.0 para que funcione con tu acción smart home.

Vinculación de Cuentas de Google con OAuth

En el flujo de código de autorización, necesitas dos extremos:

El extremo de autorización, que presenta la IU de acceso a los usuarios que aún no accedieron. El extremo de autorización también crea un código de autorización de corta duración a fin de registrar el consentimiento de los usuarios para el acceso solicitado.
El extremo de intercambio de tokens, que es responsable de dos tipos de intercambios:
1. Intercambia un código de autorización por un token de actualización de larga duración y un token de acceso de corta duración. Este intercambio se produce cuando el usuario completa el flujo de vinculación de cuentas.
2. Intercambia un token de actualización de larga duración por un token de acceso de corta duración. Este intercambio se produce cuando Google necesita un token de acceso nuevo porque este ya venció.

Lineamientos de diseño

En esta sección, se describen los requisitos y las recomendaciones de diseño para la pantalla de usuario que alojas para los flujos de vinculación de OAuth. Después de que la app de Google lo llame, la plataforma le mostrará al usuario una página de acceso a Google y una pantalla de consentimiento para vincular la cuenta. Se dirige al usuario de vuelta a la app de Google después de dar su consentimiento para vincular las cuentas.

En esta figura, se muestran los pasos que debe seguir un usuario para vincular su Cuenta de Google a tu sistema de autenticación. En la primera captura de pantalla, se muestra la vinculación iniciada por el usuario desde tu plataforma. En la segunda, se muestra el acceso del usuario a Google, mientras que en la tercera se muestra el consentimiento y la confirmación del usuario para vincular su Cuenta de Google con la app. La captura de pantalla final muestra una cuenta de usuario vinculada correctamente en la app de Google. — **Figura 1:** Acceso de usuario que vincula la cuenta a Google y pantallas de consentimiento.

Requisitos

Debes comunicar que la cuenta del usuario se vinculará a Google, no a un producto específico de Google, como Google Home o Asistente de Google.
Debes contar con una declaración de autorización de Google, como “Al acceder, autorizas a Google a controlar tus dispositivos”. Consulta el artículo de la Autorización de Control de Dispositivos de Google de las Políticas para Desarrolladores de Google Home.
Debes proporcionar una forma para que los usuarios regresen o cancelen el servicio, si deciden no realizar la vinculación.
Debes abrir la página de vinculación de OAuth web y asegurarte de que los usuarios tengan un método claro para acceder a su Cuenta de Google, como los campos de nombre de usuario y contraseña. No uses el método de Acceso con Google (GSI) que permita a los usuarios vincular sin que se los dirija a la página de vinculación de OAuth web. Esto constituye un incumplimiento de la política de Google.

Recomendaciones

Flujo de código de autorización

Una implementación del servidor OAuth 2.0 del flujo de código de autorización consiste en 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 un de acceso para los usuarios que aún no lo hayan hecho y que registren su consentimiento el acceso solicitado. El segundo extremo es el extremo de intercambio de tokens, se usa para obtener cadenas encriptadas, denominadas tokens, que autorizan al usuario a realizar acceder a tu servicio.

Cuando una aplicación de Google necesita llamar a una de las APIs de tu servicio, Google usa estos extremos a fin de obtener permiso de los usuarios para llamar a estas APIs por ellos.

Una sesión de flujo de código de autorización de OAuth 2.0 que inicia Google tiene la siguiente flujo:

Google abre el extremo de autorización en el navegador del usuario. Si el flujo que se inician en un dispositivo solo de voz para una Action, Google transfiere ejecución a un teléfono.
El usuario accede a su cuenta, si aún no lo hizo, y le otorga permiso a Google para acceder a sus datos con tu API, si aún no han otorgado permiso.
Tu servicio crea un código de autorización y se lo devuelve a Google. Tareas pendientes por lo que debes redireccionar el navegador del usuario de vuelta a Google con el código de autorización. que se adjuntan a la solicitud.
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.
Después de que el usuario completa el flujo de vinculación de cuentas, cada que envió Google contiene un token de acceso.

Maneja solicitudes de autorización

Cuando necesitas vincular cuentas con el 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 que asignaste a 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`	Es el tipo de valor que se debe mostrar en la respuesta. Para OAuth 2.0 de código de autorización, el tipo de respuesta siempre es `code`.
`user_locale`	La configuración de idioma de la Cuenta de Google en RFC5646 que se usa para localizar tu contenido en el idioma de preferencia del usuario.

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&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE

Para que tu extremo de autorización controle las solicitudes de acceso, haz lo siguiente pasos:

Verifica que client_id coincida con el ID de cliente que le asignaste a Google y que redirect_uri coincida con la URL de redireccionamiento que proporcionó Google para tu servicio. Estas verificaciones son importantes para evitar que se otorguen el acceso a apps cliente no deseadas o configuradas incorrectamente. Si admites varias Flujos de OAuth 2.0; también confirma que response_type sea code.
Verifica si el usuario accedió a tu servicio. Si el usuario no accedió, completar el flujo de acceso o registro del servicio.
Genera un código de autorización para que Google lo use 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.

Confirma que la URL especificada por el parámetro redirect_uri tenga el elemento siguiente formulario:

  https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
  https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID

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. Es `authorization_code` o `refresh_token`.
`code`	Cuando es `grant_type=authorization_code`, este parámetro es el código que recibió Google de tu acceso o intercambio de tokens extremo.
`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 es `grant_type=refresh_token`, este parámetro es el el token de actualización que Google recibió de 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 un mensaje de código de autorización a Google, Google envía una solicitud a tu intercambio de token para intercambiar el código de autorización por un token de acceso y una actualización token.

Para estas solicitudes, el valor de grant_type es authorization_code, y la El valor de code es el valor del código de autorización que otorgaste anteriormente. a Google. El siguiente es un ejemplo de una solicitud para intercambiar un Código de autorización para 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 la ejecución del siguiente comando: pasos:

Verifica que el client_id identifique el origen de la solicitud como un origen y que client_secret coincida con el valor esperado.
Verifica que el código de autorización sea válido y no haya vencido, y que el el ID de cliente especificado en la solicitud coincide con el ID de cliente asociado con el código de autorización.
Confirma que la URL especificada por el parámetro redirect_uri sea idéntica según el valor que se usó en la solicitud de autorización inicial.
Si no puedes verificar todos los criterios anteriores, devuelve una solicitud HTTP Error 400 de solicitud incorrecta con {"error": "invalid_grant"} como cuerpo.
De lo contrario, usa el ID de usuario del código de autorización para generar 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 deben no deben poder adivinarse. Para los tokens de acceso, registra también la fecha de vencimiento de el token, que suele ser una hora después de que se emite. Los tokens de actualización no vencen.

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 los registros el vencimiento del token de acceso. Cuando vence el token de acceso, Google usa el token de actualización para obtener un nuevo token de acceso 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 intercambio de token extremo 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 anteriormente Google. El siguiente es un ejemplo de una solicitud para intercambiar un token de actualización para 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 mediante la ejecución de los siguientes pasos:

Verifica que client_id identifique el origen de la solicitud como Google. para que client_secret coincida con el valor esperado.
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.
Si no puedes verificar todos los criterios anteriores, muestra un error HTTP 400 Error de solicitud incorrecta con {"error": "invalid_grant"} como cuerpo.
De lo contrario, usa el ID de usuario del token de actualización para generar un permiso token. Estos tokens pueden ser de cualquier valor de cadena, pero deben ser únicos representan al usuario y al cliente para el que es el token, y no deben ser adivinable. Para los tokens de acceso, registra también la hora de vencimiento del token, por lo general, una hora después de emitir el token.

Devuelve el siguiente objeto JSON en el cuerpo del protocolo HTTPS respuesta:

{
"token_type": "Portador",
“access_token”: “ACCESS_TOKEN”,
“expires_in”: SECONDS_TO_EXPIRATION
}.

Controla las solicitudes userinfo

El extremo userinfo es un recurso protegido de OAuth 2.0 que muestra reclamos sobre el usuario vinculado. La implementación y el alojamiento del extremo userinfo son opcionales, excepto en los siguientes casos de uso:

Acceso a la cuenta vinculada con Google One Tap.
Suscripción sin inconvenientes en Android TV.

Una vez que el token de acceso se recupera correctamente del extremo del token, Google envía una solicitud al extremo userinfo para recuperar la información básica de perfil del usuario vinculado.

Encabezados de la solicitud del extremo userinfo
`Authorization header`	El token de acceso del tipo portador.

Por ejemplo, si el extremo userinfo está disponible en https://myservice.example.com/userinfo, una solicitud podría verse de la siguiente manera:

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

Para que tu extremo userinfo controle las solicitudes, sigue estos pasos:

Extrae el token de acceso del encabezado de autorización y muestra la información del usuario asociada con el token de acceso.
Si el token de acceso no es válido, muestra un error HTTP 401 No autorizado con el encabezado de respuesta WWW-Authenticate. A continuación, se muestra un ejemplo de una respuesta de error de userinfo:
```
HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
```
Si se muestra una respuesta de error 401 No autorizado o cualquier otra respuesta de error no exitosa durante el proceso de vinculación, el error no se podrá recuperar, el token recuperado se descartará y el usuario deberá volver a iniciar el proceso de vinculación.

Si el token de acceso es válido, devuelve una respuesta HTTP 200 con el siguiente objeto JSON en el cuerpo del protocolo HTTPS respuesta:

{
"sub": "USER_UUID",
"email": "EMAIL_ADDRESS",
"given_name": "FIRST_NAME",
"family_name": "LAST_NAME",
"name": "FULL_NAME",
"picture": "PROFILE_PICTURE",
}

Si el extremo userinfo muestra una respuesta exitosa HTTP 200, el token y las reclamaciones recuperados se registran con la Cuenta de Google del usuario.

respuesta del extremo userinfo
`sub`	Un ID único que identifica al usuario en tu sistema.
`email`	Dirección de correo electrónico del usuario.
`given_name`	Opcional: Es el nombre del usuario.
`family_name`	Opcional: Apellido del usuario.
`name`	Opcional: Es el nombre completo del usuario.
`picture`	Opcional: Foto de perfil del usuario.

Lista de tareas para desarrolladores

Crea un proyecto de nube a nube