Integra reCAPTCHA Enterprise en apps para Android

En esta página, se explica cómo integrar reCAPTCHA Enterprise en tu app para Android.

Si quieres ofrecer desafíos visuales para el tráfico sospechoso, puedes usar la API de reCAPTCHA de SafetyNet.

Importante: El SDK usa código dinámico y de reflexión para permitir la modificación y el perfeccionamiento del sistema de detección en las aplicaciones o los SDKs implementados. El conjunto de clases que está disponible en el sistema está restringido a una lista controlada para evitar interferencias en la aplicación.

Antes de comenzar

1. Prepara tu entorno para reCAPTCHA Enterprise.

2. Crea una clave de reCAPTCHA para la plataforma de apps para Android.

   Como alternativa, puedes copiar el ID de una clave de reCAPTCHA existente para Android mediante uno de los siguientes pasos:

   • Para copiar el ID de una clave existente desde Google Cloud Console, haz lo siguiente:

     1. Ve a la página de reCAPTCHA Enterprise.

        Ir a reCAPTCHA Enterprise

     2. En la lista de claves de reCAPTCHA, mantén el puntero sobre la clave que deseas copiar y, luego, haz clic en .
   • Para copiar el ID de una clave existente con la API de REST, usa el método projects.keys.list.
   • Para copiar el ID de una clave existente con la gcloud CLI, usa el comando gcloud recaptcha keys list.

Cómo preparar tu entorno de Android

Advertencia: No migres al SDK de Android 18.2.0, ya que es posible que tu app no funcione debido a algunos errores internos. Para evitar estos problemas, migra directamente al SDK de Android 18.2.1 o una versión posterior. Para obtener más detalles, consulta el informe de problemas en GitHub.

Android nativo

1. Para preparar tu entorno de desarrollo, descarga e instala la versión más reciente de Android Studio.

2. Asegúrate de tener una app con el valor mínimo del SDK de Android configurado en nivel de API 19: Android 4.4 (KitKat). Puedes establecer el SDK mínimo de tu app en el nivel de API 19 o crear una nueva app para dispositivos móviles.

3. Si estás creando una nueva app para dispositivos móviles, inicia un nuevo proyecto de Android Studio para crear una aplicación de prueba:

   1. Selecciona Empty Activity. Si deseas usar Jetpack Compose en tu app, elige Empty Compose Activity.
   2. Configura el lenguaje en kotlin.
   3. Establece el valor mínimo del SDK en API 19: Android 4.4 (KitKat).

4. Asegúrate de que el repositorio Maven de Google google() esté en la lista de repositorios del archivo build.gradle de nivel de proyecto como se muestra en el siguiente fragmento:

   allprojects {
       repositories {
           google()
       }
   }
   

   Para obtener más información, consulta el repositorio de Maven de Google.

5. Para agregar la dependencia de la API de reCAPTCHA Enterprise, agrega la siguiente regla de compilación a la sección dependencies del archivo build.gradle al nivel de la app.

     implementation 'com.google.android.recaptcha:recaptcha:18.5.0-beta02'
   

   Si quieres obtener más información para agregar dependencias en apps para Android, consulta Cómo agregar dependencias de compilación.

6. Agrega un permiso de Internet entre la primera etiqueta <manifest> y la primera etiqueta <application> en el manifiesto de tu aplicación (por ejemplo, AndroidManifest.xml). Este permiso es obligatorio porque la API de reCAPTCHA Enterprise implica operaciones de red.

   <manifest ...>
   
       <uses-permission android:name="android.permission.INTERNET" />
   
       <application ...>
       ...
     </application>
   </manifest>
   

7. Si deseas usar las bibliotecas de AndroidX en tu proyecto nuevo, compila el SDK para Android 9.0 o versiones posteriores y agrega el siguiente fragmento de código a tu gradle.properties.

   android.useAndroidX=true
   android.enableJetifier=true
   

   Para obtener más información, consulta Cómo migrar a AndroidX.

Flutter

Si quieres obtener instrucciones detalladas para usar reCAPTCHA Enterprise a través de Flutter, consulta la documentación de Flutter.

ReactNative

Si quieres obtener instrucciones detalladas para usar reCAPTCHA Enterprise mediante React Native, consulta la documentación de React Native.

Integra reCAPTCHA Enterprise a tu app para Android

1. Crea una instancia de cliente con la clave reCAPTCHA (KEY_ID) que creaste en tu app para Android.

   Nota: Debes usar el cliente de reCAPTCHA Enterprise solo una vez durante el ciclo de vida de tu app.

   Kotlin

   class MainActivity : AppCompatActivity() {
   
       private lateinit var recaptchaClient: RecaptchaClient
   
       override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
         initializeRecaptchaClient()
         // ... rest of onCreate code
       }
   
       private fun initializeRecaptchaClient() {
         lifecycleScope.launch {
           Recaptcha.getClient(application, "KEY_ID")
             .onSuccess { client ->
               recaptchaClient = client
             }
             .onFailure { exception ->
               // Handle communication errors ...
               // See "Handle communication errors" section
             }
         }
       }
   
       // ... rest of activity code.
   }
   

   Java

   public final class MainActivity extends Activity {
     @Nullable private RecaptchaTasksClient recaptchaTasksClient = null;
   
     @Override
     protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       setContentView(R.layout.activity_main);
       initializeRecaptchaClient();
       // ... rest of onCreate code
     }
   
     private void initializeRecaptchaClient() {
       Recaptcha
         .getTasksClient(getApplication(), "KEY_ID")
         .addOnSuccessListener(
             this,
             new OnSuccessListener<RecaptchaTasksClient>() {
               @Override
               public void onSuccess(RecaptchaTasksClient client) {
                 MainActivity.this.recaptchaTasksClient = client;
               }
             })
         .addOnFailureListener(
             this,
             new OnFailureListener() {
               @Override
               public void onFailure(@NonNull Exception e) {
                 // Handle communication errors ...
                 // See "Handle communication errors" section
               }
             });
     }
   
     // ... rest of activity code.
   }
   

   Nota: Si la API pasa una instancia de ApiException a onFailure(), debes controlar cada código de estado posible que puedes recuperar con getStatusCode(). Para obtener más información, consulta Cómo controlar los errores de comunicación.

2. Para cada acción de la app que esté protegida con reCAPTCHA Enterprise, llama al método execute y pasa una RecaptchaAction. reCAPTCHA Enterprise proporciona un conjunto integrado de acciones y, si es necesario, puedes crear acciones personalizadas.

   En el siguiente fragmento de código, se muestra cómo usar execute para proteger una acción LOGIN.

   Kotlin

   private fun executeLoginAction() {
     lifecycleScope.launch {
       recaptchaClient
         .execute(RecaptchaAction.LOGIN)
         .onSuccess { token ->
           // Handle success ...
           // See "What's next" section for instructions
           // about handling tokens.
         }
         .onFailure { exception ->
           // Handle communication errors ...
           // See "Handle communication errors" section
         }
     }
   }
   

   Java

   private void executeLoginAction(View v) {
     assert recaptchaTasksClient != null;
     recaptchaTasksClient
       .executeTask(RecaptchaAction.LOGIN)
       .addOnSuccessListener(
           this,
           new OnSuccessListener<String>() {
             @Override
             public void onSuccess(String token) {
               // Handle success ...
               // See "What's next" section for instructions
               // about handling tokens.
             }
           })
       .addOnFailureListener(
           this,
           new OnFailureListener() {
             @Override
             public void onFailure(@NonNull Exception e) {
               // Handle communication errors ...
               // See "Handle communication errors" section
             }
           });
   }
   

En el siguiente fragmento de código de muestra, se observa una integración completa de los métodos getClient() y execute() en una sola app de actividad:

Kotlin

class MainActivity : AppCompatActivity() {

  private lateinit var recaptchaClient: RecaptchaClient

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)
    initializeRecaptchaClient()
    findViewById<View>(R.id.btn_login).setOnClickListener { executeLoginAction() }
    findViewById<View>(R.id.btn_redeem).setOnClickListener { executeRedeemAction() }
  }

  private fun initializeRecaptchaClient() {
    lifecycleScope.launch {
      Recaptcha.getClient(application, "KEY_ID")
        .onSuccess { client ->
          recaptchaClient = client
        }
        .onFailure { exception ->
          // Handle communication errors ...
          // See "Handle communication errors" section
        }
    }
  }

  private fun executeLoginAction() {
    lifecycleScope.launch {
      recaptchaClient
        .execute(RecaptchaAction.LOGIN)
        .onSuccess { token ->
          // Handle success ...
          // See "What's next" section for instructions
          // about handling tokens.
        }
        .onFailure { exception ->
          // Handle communication errors ...
          // See "Handle communication errors" section
        }
    }
  }

  private fun executeRedeemAction(){
    lifecycleScope.launch {
      recaptchaClient
        .execute(RecaptchaAction.custom("redeem"))
        .onSuccess { token ->
          // Handle success ...
          // See "What's next" section for instructions
          // about handling tokens.
        }
        .onFailure { exception ->
          // Handle communication errors ...
          // See "Handle communication errors" section
        }
    }
  }
}

Java

public final class MainActivity extends Activity {
  @Nullable private RecaptchaTasksClient recaptchaTasksClient = null;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    initializeRecaptchaClient();
    findViewById(R.id.btn_login).setOnClickListener(this::executeLoginAction);
    findViewById(R.id.btn_redeem).setOnClickListener(this::executeRedeemAction);
  }

  private void initializeRecaptchaClient() {
    Recaptcha
      .getTasksClient(getApplication(), "KEY_ID")
      .addOnSuccessListener(
          this,
          new OnSuccessListener<RecaptchaTasksClient>() {
            @Override
            public void onSuccess(RecaptchaTasksClient client) {
              MainActivity.this.recaptchaTasksClient = client;
            }
          })
      .addOnFailureListener(
          this,
          new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
              // Handle communication errors ...
              // See "Handle communication errors" section
            }
          });
  }

  private void executeLoginAction(View v) {
    assert recaptchaTasksClient != null;
    recaptchaTasksClient
      .executeTask(RecaptchaAction.LOGIN)
      .addOnSuccessListener(
          this,
          new OnSuccessListener<String>() {
            @Override
            public void onSuccess(String token) {
              // Handle success ...
              // See "What's next" section for instructions
              // about handling tokens.
            }
          })
      .addOnFailureListener(
          this,
          new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
              // Handle communication errors ...
              // See "Handle communication errors" section
            }
          });
  }

  private void executeRedeemAction(View v) {
    assert recaptchaTasksClient != null;
    recaptchaTasksClient
      .executeTask(RecaptchaAction.custom("redeem"))
      .addOnSuccessListener(
          this,
          new OnSuccessListener<String>() {
            @Override
            public void onSuccess(String token) {
              // Handle success ...
              // See "What's next" section for instructions
              // about handling tokens.
            }
          })
      .addOnFailureListener(
          this,
          new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
              // Handle communication errors ...
              // See "Handle communication errors" section
            }
          });
  }
}

Precaución: getClient() y execute() pueden tardar varios segundos en completarse en un dispositivo. Por lo tanto, te recomendamos que hagas lo siguiente:

• Inicializa el cliente cuando se inicia la app. Por ejemplo, en la llamada onCreate() de una clase Application personalizada.
• Asegúrate de que las llamadas a execute() no bloqueen un evento de la IU. La integración de execute() en tu app no debería bloquear un evento de la IU, como presionar un botón. Por ejemplo, puedes llamar a execute() de forma asíncrona cuando creas una vista.

Nota: Google Play Store requiere que completes el formulario de seguridad de los datos de Google Play antes de subir la app a Play Store. Revisa los requisitos de divulgación de datos de Google Play para encontrar la información que necesitas sobre el SDK de reCAPTCHA Enterprise para Android y completar el formulario de seguridad de los datos.

Establece un tiempo de espera para las llamadas a la API

Puedes especificar un valor de tiempo de espera para las APIs de getClient y execute con la propiedad timeout de cada API.

Se utiliza un tiempo de espera predeterminado de 10 segundos para getClient y de 10 segundos para las APIs de execute.

Kotlin

• Establece el tiempo de espera para llamar a getClient.

      lifecycleScope.launch {
        Recaptcha.getClient(application, "KEY_ID", timeout = 20000L)
          .onSuccess { client ->
            recaptchaClient = client
          }
          .onFailure { exception ->
            // Handle communication errors ...
            // See "Handle communication errors" section
          }
      }
  

  Este fragmento de código establece el tiempo de espera de getClient en 20 segundos.

• Establece el tiempo de espera para llamar a execute.

      lifecycleScope.launch {
        recaptchaClient
          .execute(RecaptchaAction.LOGIN(), timeout = 10000L)
          .onSuccess { token ->
            // Handle success ...
            // See "What's next" section for instructions
            // about handling tokens.
          }
          .onFailure { exception ->
            // Handle communication errors ...
            // See "Handle communication errors" section
          }
      }
  

  Este fragmento de código establece el tiempo de espera de execute en 10 segundos.

Java

• Establece el tiempo de espera para llamar a getClient.

    Recaptcha
      .getTasksClient(getApplication(), "KEY_ID", 20000L)
      .addOnSuccessListener(
          this,
          new OnSuccessListener<RecaptchaTasksClient>() {
            @Override
            public void onSuccess(RecaptchaTasksClient client) {
              MainActivity.this.recaptchaTasksClient = client;
            }
          })
      .addOnFailureListener(
          this,
          new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
              // Handle communication errors ...
              // See "Handle communication errors" section
            }
          });
  

  Este fragmento de código establece el tiempo de espera de getClient en 20 segundos.

• Establece el tiempo de espera para llamar a execute.

    recaptchaTasksClient
      .executeTask(RecaptchaAction.custom("redeem"), 10000L)
      .addOnSuccessListener(
          this,
          new OnSuccessListener<String>() {
            @Override
            public void onSuccess(String token) {
              // Handle success ...
              // See "What's next" section for instructions
              // about handling tokens.
            }
          })
      .addOnFailureListener(
          this,
          new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
              // Handle communication errors ...
              // See "Handle communication errors" section
            }
          });
  

  Este fragmento de código establece el tiempo de espera de execute en 10 segundos.

Maneja errores de comunicación

Si la app no puede comunicarse correctamente con el servicio de reCAPTCHA, es posible que la API haya detectado un error. Debes agregar lógica a tu app para manejar de forma correcta esos errores.

Para obtener más información sobre las mitigaciones de errores comunes de la API, consulta RecaptchaErrorCode.

Referencia de la API

Para obtener una referencia completa de la API de reCAPTCHA para Android, consulta com.google.android.recaptcha.

¿Qué sigue?

• Para evaluar el token de respuesta de reCAPTCHA, crea una evaluación.

  Nota: Los tokens de respuesta de reCAPTCHA se evalúan y anotan desde tu servidor de backend, no desde el dispositivo móvil.