Integra reCAPTCHA Enterprise con le app per Android

Questa pagina spiega come integrare reCAPTCHA Enterprise nella tua app per Android.

Se vuoi mostrare verifiche visive per il traffico sospetto, puoi utilizzare l'API reCAPTCHA SafetyNet.

Importante: l'SDK utilizza codice dinamico e riflessi per consentire la modifica e il perfezionamento del sistema di rilevamento nelle applicazioni/gli SDK esistenti di cui è stato eseguito il deployment. L'insieme di classi disponibili nel sistema è limitato a un elenco controllato per evitare interferenze con l'applicazione.

Prima di iniziare

1. Prepara l'ambiente per reCAPTCHA Enterprise.

2. Crea una chiave reCAPTCHA per la piattaforma di app Android.

   In alternativa, puoi copiare l'ID di una chiave reCAPTCHA esistente per Android eseguendo uno dei seguenti passaggi:

   • Per copiare l'ID di una chiave esistente dalla console Google Cloud, segui questi passaggi:

     1. Vai alla pagina reCAPTCHA Enterprise.

        Vai a reCAPTCHA Enterprise

     2. Nell'elenco delle chiavi reCAPTCHA, tieni il puntatore del mouse sulla chiave che vuoi copiare e fai clic su .
   • Per copiare l'ID di una chiave esistente con l'API REST, usa il metodo projects.keys.list.
   • Per copiare l'ID di una chiave esistente utilizzando gcloud CLI, utilizza il comando gcloud recaptcha keys list.

Prepara l'ambiente Android

Avviso: non eseguire la migrazione all'SDK Android 18.2.0, perché potrebbe rendere l'app non funzionante a causa di alcuni errori interni. Per evitare questi problemi, esegui la migrazione direttamente all'SDK Android 18.2.1 o versioni successive. Per maggiori dettagli, consulta il report del problema su GitHub.

Android nativo

1. Prepara l'ambiente di sviluppo scaricando e installando l'ultima versione di Android Studio.

2. Assicurati di avere un'app con il valore minimo dell'SDK Android impostato su API 19: Android 4.4 (Lollipop). Puoi impostare l'SDK minimo della tua app sull'API 19 o creare una nuova app mobile.

3. Se stai creando una nuova app mobile, crea un'applicazione di test avviando un nuovo progetto Android Studio:

   1. Seleziona Attività vuota. Se vuoi utilizzare Jetpack Compose nell'app, scegli Empty Compose Activity.
   2. Imposta la lingua su kotlin.
   3. Imposta il valore minimo dell'SDK su API 19: Android 4.4 (Lollipop).

4. Assicurati che il repository Maven di Google google() sia nell'elenco dei repository nel file build.gradle a livello di progetto, come mostrato nello snippet seguente:

   allprojects {
       repositories {
           google()
       }
   }
   

   Per ulteriori informazioni, consulta il Repository Maven di Google.

5. Per aggiungere la dipendenza dell'API reCAPTCHA Enterprise, aggiungi la seguente regola di build alla sezione dependencies del file build.gradle a livello di app.

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

   Per saperne di più sull'aggiunta di dipendenze nelle app per Android, consulta Aggiungere dipendenze build.

6. Aggiungi l'autorizzazione Internet tra il primo tag <manifest> e il primo tag <application> nel file manifest dell'applicazione (ad esempio AndroidManifest.xml). Questa autorizzazione è obbligatoria perché l'API reCAPTCHA Enterprise prevede operazioni di rete.

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

7. Se vuoi utilizzare le librerie AndroidX nel nuovo progetto, compila l'SDK in Android 9.0 o versioni successive e aggiungi il seguente snippet di codice a gradle.properties.

   android.useAndroidX=true
   android.enableJetifier=true
   

   Per maggiori informazioni, consulta la sezione Migrazione ad AndroidX.

Flutter

Per istruzioni dettagliate sull'utilizzo di reCAPTCHA Enterprise tramite Flutter, consulta la documentazione di Flutter.

ReactNative

Per istruzioni dettagliate sull'utilizzo di reCAPTCHA Enterprise tramite React Native, consulta la documentazione di React Native.

Integra reCAPTCHA Enterprise con la tua app per Android

1. Crea l'istanza di un client utilizzando la chiave reCAPTCHA (KEY_ID) che hai creato per la tua app per Android.

   Nota: devi utilizzare il client reCAPTCHA Enterprise solo una volta durante il ciclo di vita dell'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: se l'API passa un'istanza di ApiException in onFailure(), devi gestire ogni possibile codice di stato che puoi recuperare utilizzando getStatusCode(). Per maggiori informazioni, consulta Gestione degli errori di comunicazione.

2. Per ogni azione della tua app protetta tramite reCAPTCHA Enterprise, chiama il metodo execute che trasmette un'azione RecaptchaAction. reCAPTCHA Enterprise fornisce un insieme integrato di azioni e, se necessario, puoi creare azioni personalizzate.

   Il seguente snippet di codice mostra come utilizzare execute per proteggere un'azione 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
             }
           });
   }
   

Il seguente snippet di codice campione mostra un'integrazione completa dei metodi getClient() e execute() in una singola app di attività:

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
            }
          });
  }
}

Attenzione: il completamento di getClient() e execute() su un dispositivo può richiedere diversi secondi. Pertanto, ti consigliamo di procedere come segue:

• Inizializza il client all'avvio dell'app. Ad esempio, nella chiamata onCreate() di una classe Application personalizzata.
• Assicurati che le chiamate execute() non blocchino un evento UI. L'integrazione di execute() nella tua app non dovrebbe bloccare un evento UI, ad esempio la pressione di un pulsante. Ad esempio, puoi chiamare execute() in modo asincrono durante la creazione di una vista.

Nota: il Google Play Store richiede la compilazione del modulo Sicurezza dei dati di Google Play prima di caricare la tua app sul Play Store. Consulta i requisiti relativi alle informative sui dati di Google Play per trovare le informazioni necessarie sull'SDK Android di reCAPTCHA Enterprise per compilare il modulo Sicurezza dei dati.

Imposta un timeout per le chiamate API

Puoi specificare un valore di timeout per le API getClient e execute utilizzando la proprietà timeout di ogni API.

Viene utilizzato un timeout predefinito di 10 secondi per getClient e di 10 secondi per le API execute.

Kotlin

• Imposta il timeout per la chiamata al numero getClient.

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

  Questo snippet di codice imposta il timeout di getClient su 20 secondi.

• Imposta il timeout per la chiamata al numero 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
          }
      }
  

  Questo snippet di codice imposta il timeout di execute su 10 secondi.

Java

• Imposta il timeout per la chiamata al numero 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
            }
          });
  

  Questo snippet di codice imposta il timeout di getClient su 20 secondi.

• Imposta il timeout per la chiamata al numero 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
            }
          });
  

  Questo snippet di codice imposta il timeout di execute su 10 secondi.

Gestire gli errori di comunicazione

Se la tua app non riesce a comunicare correttamente con il servizio reCAPTCHA, è possibile che l'API abbia riscontrato un errore. Per gestire correttamente questi errori, devi aggiungere una logica nell'app.

Per ulteriori dettagli sulle mitigazioni per gli errori comuni relativi all'API, consulta RecaptchaErrorCode.

Riferimento API

Per un riferimento completo dell'API reCAPTCHA per Android, consulta com.google.android.recaptcha.

Passaggi successivi

• Per valutare il token di risposta reCAPTCHA, crea una valutazione.

  Nota: i token di risposta reCAPTCHA vengono valutati e annotati dal server di backend, non dal dispositivo mobile.