App Flip para Android

Una vez que tengas una implementación de OAuth 2.0, puedes configurar App Flip basado en OAuth, que permite a tus usuarios de Android vincular más rápido sus cuentas en tu sistema de autenticación con sus Cuentas de Google. En las siguientes secciones, se describe cómo diseñar e implementar App Flip para tu acción smart home.

Lineamientos de diseño

En esta sección, se describen los requisitos de diseño y las recomendaciones para la pantalla de consentimiento de vinculación de cuentas de Apps Flip. Una vez que Google llama a tu app, esta muestra la pantalla de consentimiento al usuario.

Requisitos

  1. Debes comunicar que la cuenta del usuario se vincula a Google, no a un producto específico de Google, como Google Home o el Asistente de Google.

Recomendaciones

Te recomendamos que hagas lo siguiente:

  1. Muestra la Política de Privacidad de Google. Incluye un vínculo a la Política de Privacidad de Google en la pantalla de consentimiento.

  2. Datos que se compartirán. Usa un lenguaje claro y conciso para indicarle al usuario qué datos de Google requiere y por qué.

  3. Llamado a la acción claro. En tu pantalla de consentimiento, indica un llamado a la acción claro, como "Aceptar y vincular". Esto se debe a que los usuarios deben comprender qué datos deben compartir con Google para vincular sus cuentas.

  4. Posibilidad de cancelar. Proporciona una forma para que los usuarios retrocedan o cancelen si eligen no vincularse.

  5. Capacidad de desvincularse. Ofrece un mecanismo para desvincular a los usuarios, como una URL para la configuración de la cuenta en tu plataforma. De manera alternativa, puedes incluir un vínculo a una Cuenta de Google en la que los usuarios puedan administrar sus cuentas vinculadas.

  6. Capacidad para cambiar la cuenta de usuario Sugerir un método para que los usuarios cambien sus cuentas Esto es especialmente beneficioso si los usuarios tienden a tener varias cuentas.

    • Si un usuario debe cerrar la pantalla de consentimiento para cambiar de cuenta, envía un error recuperable a Google a fin de que el usuario pueda acceder a la cuenta deseada con la vinculación de OAuth y el flujo implícito.

  7. Incluya su logotipo. Muestre el logotipo de su empresa en la pantalla de consentimiento. Usa tus lineamientos de estilo para colocar tu logotipo. Si también deseas mostrar el logotipo de Google, consulta Logotipos y marcas comerciales.

En esta figura, se muestra un ejemplo de pantalla de consentimiento con menciones de los requisitos individuales y las recomendaciones que se deben seguir cuando se diseña una pantalla de consentimiento del usuario.
Figura 1: Lineamientos de diseño de la pantalla de consentimiento de vinculación de cuentas.

Configuración de la versión de la app basada en OAuth

En las siguientes secciones, se describen los requisitos para App Flip basada en OAuth y la configuración de tu proyecto de App Flip en la Consola de Actions.

Cómo crear una Acción de casa inteligente y configurar un servidor de OAuth 2.0

Antes de configurar App Flip, debes hacer lo siguiente:

Cómo configurar App Flip en la Consola de Actions

En la siguiente sección, se describe cómo configurar App Flip en la Consola de Actions.

  1. Completa todos los campos de la sección Información del cliente de OAuth. (si no se admite App Flip, se usa OAuth normal como resguardo).
  2. En la sección Usa la app para la vinculación de cuentas (opcional), marca la opción Habilitar para Android.
  3. Completa los siguientes campos:
    • ID de aplicación. El ID de aplicación es un ID único que estableces para tu aplicación.
    • Firma de la app. Las apps para Android deben estar "firmadas" con un certificado de clave pública antes de que se puedan instalar. Para obtener más información sobre cómo obtener la firma de tu app, consulta Cómo autenticar tu cliente.
    • Intent de autorización. En este campo, ingresa una string que especifique tu acción de intent.
  4. Si deseas configurar tu cliente de forma opcional, agrega permisos y haz clic en Agregar permiso en Configurar tu cliente (opcional).
  5. Haz clic en Guardar.

Cómo implementar App Flip en tus apps para Android

Para implementar App Flip, debes modificar el código de autorización del usuario en tu app a fin de aceptar un vínculo directo de Google.

OAuth-based App Flip linking (App Flip) inserts your Android app into the Google Account Linking flow. A traditional account linking flow requires the user to enter their credentials in the browser. The use of App Flip defers user sign-in to your Android app, which allows you to leverage existing authorizations. If the user is signed in to your app, they don't need to re-enter their credentials to link their account. A minimal amount of code changes are required to implement App Flip on your Android app.

In this document, you learn how to modify your Android app to support App Flip.

Try the sample

The App Flip linking sample app demonstrates an App Flip-compatible account linking integration on Android. You can use this app to verify how to respond to an incoming App Flip intent from Google mobile apps.

The sample app is preconfigured to integrate with the App Flip Test Tool for Android, which you can use to verify your Android app's integration with App Flip before you configure account linking with Google. This app simulates the intent triggered by Google mobile apps when App Flip is enabled.

How it works

The following steps are required to carry out an App Flip integration:

  1. The Google app checks if your app is installed on the device using its package name.
  2. The Google app uses a package signature check to validate that the installed app is the correct app.
  3. The Google app builds an intent to start a designated activity in your app. This intent includes additional data required for linking. It also checks to see if your app supports App Flip by resolving this intent through the Android framework.
  4. Your app validates that the request is coming from the Google app. To do so, your app checks the package signature and the provided client ID.
  5. Your app requests an authorization code from your OAuth 2.0 server. At the end of this flow, it returns either an authorization code or an error to the Google app.
  6. The Google app retrieves the result and continues with account linking. If an authorization code is provided, the token exchange happens server-to-server, the same way it does in the browser-based OAuth linking flow.

Modify your Android app to support App Flip

To support App Flip, make the following code changes to your Android app:

  1. Add an <intent-filter> to your AndroidManifest.xml file with an action string that matches the value you entered in the App Flip Intent field.

    <activity android:name="AuthActivity">
  <!-- Handle the app flip intent -->
  <intent-filter>
    <action android:name="INTENT_ACTION_FROM_CONSOLE"/>
    <category android:name="android.intent.category.DEFAULT"/>
  </intent-filter>
</activity>

  2. Validate the calling app's signature.

    private fun verifyFingerprint(
        expectedPackage: String,
        expectedFingerprint: String,
        algorithm: String
): Boolean {

    callingActivity?.packageName?.let {
        if (expectedPackage == it) {
            val packageInfo =
                packageManager.getPackageInfo(it, PackageManager.GET_SIGNATURES)
            val signatures = packageInfo.signatures
            val input = ByteArrayInputStream(signatures[0].toByteArray())

            val certificateFactory = CertificateFactory.getInstance("X509")
            val certificate =
                certificateFactory.generateCertificate(input) as X509Certificate
            val md = MessageDigest.getInstance(algorithm)
            val publicKey = md.digest(certificate.encoded)
            val fingerprint = publicKey.joinToString(":") { "%02X".format(it) }

            return (expectedFingerprint == fingerprint)
        }
    }
    return false
}

  3. Extract the client ID from the intent parameters and verify that the client ID matches the expected value.

    private const val EXPECTED_CLIENT = "<client-id-from-actions-console>"
private const val EXPECTED_PACKAGE = "<google-app-package-name>"
private const val EXPECTED_FINGERPRINT = "<google-app-signature>"
private const val ALGORITHM = "SHA-256"
...

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    val clientId = intent.getStringExtra("CLIENT_ID")

    if (clientId == EXPECTED_CLIENT &&
        verifyFingerprint(EXPECTED_PACKAGE, EXPECTED_FINGERPRINT, ALGORITHM)) {

        // ...authorize the user...
    }
}

  4. Upon successful authorization, return the resulting authorization code back to Google.

    // Successful result
val data = Intent().apply {
    putExtra("AUTHORIZATION_CODE", authCode)
}
setResult(Activity.RESULT_OK, data)
finish()

  5. If an error occurred, return an error result instead.

    // Error result
val error = Intent().apply {
    putExtra("ERROR_TYPE", 1)
    putExtra("ERROR_CODE", 1)
    putExtra("ERROR_DESCRIPTION", "Invalid Request")
}
setResult(-2, error)
finish()

Content of the launch intent

The Android intent that launches your app includes the following fields:

  • CLIENT_ID (String): Google client_id registered under your app.
  • SCOPE (String[]): A list of scopes requested.
  • REDIRECT_URI (String): The redirect URL.

Content of the response data

The data returned to the Google app is set in your app by calling setResult(). This data includes the following:

  • AUTHORIZATION_CODE (String): The authorization code value.
  • resultCode (int): Communicates the success or failure of the process and takes one of the following values:
    • Activity.RESULT_OK: Indicates success; an authorization code is returned.
    • Activity.RESULT_CANCELLED: Signals that the user has cancelled the process. In this case, the Google app will attempt account linking using your authorization URL.
    • -2: Indicates that an error has occurred. Different types of errors are described below.
  • ERROR_TYPE (int): The type of error, which takes one of the following values:
    • 1: Recoverable error: The Google app will attempt account linking using the authorization URL.
    • 2: Unrecoverable error: The Google app aborts account linking.
    • 3: Invalid or missing request parameters.
  • ERROR_CODE (int): An integer representing the nature of the error. To see what each error code means, refer to the table of error codes.

  • ERROR_DESCRIPTION (String, optional): Human-readable status message describing the error.

A value for the AUTHORIZATION_CODE is expected when resultCode == Activity.RESULT_OK. In all other cases, the value for AUTHORIZATION_CODE needs to be empty. If resultCode == -2, then the ERROR_TYPE value is expected to be populated.

Table of error codes

The table below shows the different error codes and whether each is a recoverable or unrecoverable error:

Error code Meaning Recoverable Unrecoverable
1 INVALID_REQUEST ✔
2 NO_INTERNET_CONNECTION ✔
3 OFFLINE_MODE_ACTIVE ✔
4 CONNECTION_TIMEOUT ✔
5 INTERNAL_ERROR ✔
6 AUTHENTICATION_SERVICE_UNAVAILABLE ✔
8 CLIENT_VERIFICATION_FAILED ✔
9 INVALID_CLIENT ✔
10 INVALID_APP_ID ✔
11 INVALID_REQUEST ✔
12 AUTHENTICATION_SERVICE_UNKNOWN_ERROR ✔
13 AUTHENTICATION_DENIED_BY_USER ✔
14 CANCELLED_BY_USER ✔
15 FAILURE_OTHER ✔
16 USER_AUTHENTICATION_FAILED ✔

For all error codes, you must return the error result via setResult to ensure the appropriate fallback is triggered.

Cómo probar App Flip en tu dispositivo

Ahora que creaste una Acción y configuraste App Flip en la consola y en la app, puedes probar App Flip en tu dispositivo móvil. Puedes usar la app de Asistente de Google o la de Google Home para probar App Flip.

Para probar App Flip desde la app del Asistente, sigue estos pasos:

  1. Ve a la Consola de Actions y selecciona tu proyecto.
  2. Haga clic en Probar en la barra de navegación superior.
  3. Activa el flujo de vinculación de cuentas desde la app de Asistente:
    1. Abre la app del Asistente de Google.
    2. Haz clic en Configuración.
    3. En la pestaña Asistente, haz clic en Control de la casa.
    4. Haga clic en Agregar(+).
    5. Selecciona tu acción en la lista de proveedores. Tendrá el prefijo “[test]” en la lista. Cuando seleccionas la acción [test] de la lista, se debe abrir la app.
    6. Verifica que se haya iniciado tu app y comienza a probar el flujo de autorización.

Para probar la función Flip desde la app de Home, sigue estos pasos:

  1. Ve a la Consola de Actions y selecciona tu proyecto.
  2. Haga clic en Probar en la barra de navegación superior.
  3. Activa el flujo de vinculación de cuentas desde la app de Home:
    1. Abre la app de Google Home.
    2. Haz clic en el botón +.
    3. Haz clic en Configurar dispositivo.
    4. Haga clic en ¿Ya tiene otros configurados?
    5. Selecciona tu acción de casa inteligente de la lista de proveedores. Tendrá el prefijo “[test]” en la lista. Cuando seleccionas la acción [test] de la lista, se debe abrir la app.
    6. Verifica que se haya iniciado tu app y comienza a probar el flujo de autorización.
Anterior
Cree un proyecto de Actions
Siguiente
Identifica y sincroniza