Wysyłanie prośby o weryfikację przez SMS-a w aplikacji na Androida

Aby automatycznie weryfikować numery telefonów, musisz wdrożyć zarówno klienta, jak i serwer procesu weryfikacji. W tym dokumencie opisujemy, jak zaimplementować część kliencką w aplikacji na Androida.

Aby rozpocząć proces weryfikacji numeru telefonu w aplikacji na Androida, wyślij numer telefonu na serwer weryfikacyjny i wywołaj interfejs SMS Retriever API, aby zacząć nasłuchiwać wiadomości SMS zawierającej kod jednorazowy dla aplikacji. Po otrzymaniu wiadomości wyślij kod jednorazowy z powrotem na serwer, aby zakończyć proces weryfikacji.

Aby przygotować aplikację, wykonaj czynności opisane w poniższych sekcjach.

Wymagania wstępne dotyczące aplikacji

Sprawdź, czy w pliku kompilacji Twojej aplikacji znajdują się te wartości:

• minSdkVersion 19 lub nowsza,
• compileSdkVersion 28 lub nowsza,

Konfiguracja aplikacji

W sekcjach buildscript i allprojects pliku build.gradle na poziomie projektu dodaj repozytorium Google Maven i centralne repozytorium Maven:

buildscript {
    repositories {
        google()
        mavenCentral()
    }
}

allprojects {
    repositories {
        google()
        mavenCentral()
    }
}

Dodaj zależność Usług Google Play do interfejsu SMS Retriever API do pliku build.gradle modułu. Jest to zwykle app/build.gradle:

dependencies {
  implementation 'com.google.android.gms:play-services-auth:22.0.0'
  implementation 'com.google.android.gms:play-services-auth-api-phone:18.3.1'
}

Uzyskaj numer telefonu użytkownika

Numer telefonu użytkownika możesz uzyskać w dowolny sposób, który jest odpowiedni dla Twojej aplikacji. Często najlepszym rozwiązaniem jest użycie selektora podpowiedzi, który zachęca użytkownika do wybrania numeru telefonu zapisanego na urządzeniu, dzięki czemu nie musi on wpisywać go ręcznie. Aby użyć selektora wskazówek:

// Construct a request for phone numbers and show the picker
private void requestHint() {
    HintRequest hintRequest = new HintRequest.Builder()
            .setPhoneNumberIdentifierSupported(true)
            .build();

    PendingIntent intent = Auth.CredentialsApi.getHintPickerIntent(
            apiClient, hintRequest);
    startIntentSenderForResult(intent.getIntentSender(),
            RESOLVE_HINT, null, 0, 0, 0);
}

// Obtain the phone number from the result
@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
  super.onActivityResult(requestCode, resultCode, data);
  if (requestCode == RESOLVE_HINT) {
      if (resultCode == RESULT_OK) {
          Credential credential = data.getParcelableExtra(Credential.EXTRA_KEY);
          // credential.getId();  <-- will need to process phone number string
      }
  }
}

Uruchom narzędzie do pobierania SMS-ów

Gdy chcesz zweryfikować numer telefonu użytkownika, pobierz instancję obiektu SmsRetrieverClient, wywołaj startSmsRetriever i dołącz detektory powodzenia i niepowodzenia do zadania pobierania SMS-a:

// Get an instance of SmsRetrieverClient, used to start listening for a matching
// SMS message.
SmsRetrieverClient client = SmsRetriever.getClient(this /* context */);

// Starts SmsRetriever, which waits for ONE matching SMS message until timeout
// (5 minutes). The matching SMS message will be sent using a Broadcast Intent
// with action SmsRetriever#SMS_RETRIEVED_ACTION.
Task<Void> task = client.startSmsRetriever();

// Listen for success/failure of the start Task. If in a background thread, this
// can be made blocking using Tasks.await(task, [timeout]);
task.addOnSuccessListener(new OnSuccessListener<Void>() {
  @Override
  public void onSuccess(Void aVoid) {
    // Successfully started retriever, expect broadcast intent
    // ...
  }
});

task.addOnFailureListener(new OnFailureListener() {
  @Override
  public void onFailure(@NonNull Exception e) {
    // Failed to start retriever, inspect Exception for more details
    // ...
  }
});

Zadanie pobierania SMS-ów przez maksymalnie 5 minut oczekuje na SMS-a zawierającego unikalny ciąg znaków identyfikujący Twoją aplikację.

Wysyłanie numeru telefonu na serwer

Po uzyskaniu numeru telefonu użytkownika i rozpoczęciu nasłuchiwania wiadomości SMS wyślij numer telefonu użytkownika na serwer weryfikacyjny, używając dowolnej metody (zwykle żądania HTTPS POST).

Serwer wygeneruje wiadomość weryfikacyjną i wyśle ją SMS-em na podany przez Ciebie numer telefonu. Zobacz Przeprowadzanie weryfikacji SMS-em na serwerze.

Otrzymywanie wiadomości weryfikacyjnych

Gdy na urządzeniu użytkownika zostanie odebrana wiadomość weryfikacyjna, Usługi Google Play wysyłają do aplikacji intencję SmsRetriever.SMS_RETRIEVED_ACTION, która zawiera tekst wiadomości. Aby otrzymać wiadomość weryfikacyjną, użyj BroadcastReceiver.

W module obsługi onReceive obiektu BroadcastReceiver pobierz tekst wiadomości weryfikacyjnej (i opcjonalnie adres nadawcy) z dodatków intencji:

/**
  *   BroadcastReceiver to wait for SMS messages. This can be registered either
  *   in the AndroidManifest or at runtime. Filters Intents on
  *   SmsRetriever.SMS_RETRIEVED_ACTION.
  */
public class MySMSBroadcastReceiver extends BroadcastReceiver {

  @Override
  public void onReceive(Context context, Intent intent) {
    if (SmsRetriever.SMS_RETRIEVED_ACTION.equals(intent.getAction())) {
      Bundle extras = intent.getExtras();
      Status status = (Status) extras.get(SmsRetriever.EXTRA_STATUS);

      switch(status.getStatusCode()) {
        case CommonStatusCodes.SUCCESS:
          // (Optional) Get SMS Sender address - only available in
          // GMS version 24.20 onwards, else it will return null
          String senderAddress = extras.getString(SmsRetriever.EXTRA_SMS_ORIGINATING_ADDRESS);
          // Get SMS message contents
          String message = extras.getString(SmsRetriever.EXTRA_SMS_MESSAGE);
          // Extract one-time code from the message and complete verification
          // by sending the code back to your server.
          break;
        case CommonStatusCodes.TIMEOUT:
          // Waiting for SMS timed out (5 minutes)
          // Handle the error ...
          break;
      }
    }
  }
}

Aby zarejestrować ten BroadcastReceiver, użyj tych danych:

• Filtr intencji: com.google.android.gms.auth.api.phone.SMS_RETRIEVED (wartość stałej SmsRetriever.SMS_RETRIEVED_ACTION)
• Uprawnienie: com.google.android.gms.auth.api.phone.permission.SEND (wartość stałej SmsRetriever.SEND_PERMISSION)

Możesz zarejestrować odbiornik w pliku AndroidManifest.xml aplikacji, jak w poniższym przykładzie, lub dynamicznie za pomocą Context.registerReceiver.

<receiver android:name=".MySMSBroadcastReceiver" android:exported="true"
          android:permission="com.google.android.gms.auth.api.phone.permission.SEND">
    <intent-filter>
        <action android:name="com.google.android.gms.auth.api.phone.SMS_RETRIEVED"/>
    </intent-filter>
</receiver>

Ważne: możesz wykryć, że intencja rozgłaszania pochodzi z interfejsu SMS Retriever API, dodając uprawnienie com.google.android.gms.auth.api.phone.permission.SEND do odbiornika. To ustawienie uprawnień jest dostępne w Usługach Google Play w wersji 19.8.31 lub nowszej.

Ważne: nie dodawaj uprawnienia com.google.android.gms.auth.api.phone.permission.SEND do aplikacji. To uprawnienie powinno być używane tylko do wykrywania, czy intencja pochodzi z interfejsu SMS Retriever API w odbiorniku komunikatów.

Wyślij jednorazowy kod z wiadomości weryfikacyjnej na swój serwer.

Gdy masz już tekst wiadomości weryfikacyjnej, użyj wyrażenia regularnego lub innej logiki, aby uzyskać z niej kod jednorazowy. Format kodu jednorazowego zależy od sposobu jego wdrożenia na serwerze.

Na koniec wyślij kod jednorazowy na serwer przez bezpieczne połączenie. Gdy serwer otrzyma kod jednorazowy, zapisze, że numer telefonu został zweryfikowany.

Ważne: weryfikację kodu jednorazowego musisz przeprowadzić na serwerze, a nie w aplikacji klienckiej.