Android client integration

Integration steps

Download the SDK

Log on to the Phone Number Verification Service console. On the Overview page, find the API&SDK area on the right and click Download Now. On the API&SDK page, download and decompress the SDK as instructed.

Import the SDK

Drag the .aar file (including alicom_captcha_android_vx.y.z_date.aar) from the SDK package to the libs folder in your project. Verify that the .aar file is added to the Library, and then add the following code to the project's build.gradle file:

repositories {
        flatDir {
            dirs 'libs'
        }
  }

Add a dependency for the .aar package. By default, Android Archive (AAR) files do not pass on third-party dependencies. You must add them manually.

implementation(name: 'alicom_captcha_android_vx.y.z_date', ext: 'aar')

Configuration for non-Kotlin projects

Configure the root build.gradle file:

ext.kotlin_version = "1.4.10"
dependencies {
    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
}

Configure the module's build.gradle file:

apply plugin: 'kotlin-android'
dependencies {
      implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
}

Add permissions

<!--Required - Requested by default-->
<uses-permission android:name="android.permission.INTERNET" />
<!--Required - Not requested by default-->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<!--Optional - Dynamic request required for Android 6.0 or later (Stores logs to help analyze errors. Log path: /sdcard/Android/data/Your
PackageName/files/Alicom/captcha_log.txt)-->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

Obfuscation rules

The validation SDK is already obfuscated. Add the following rules to your obfuscation configuration. Do not obfuscate the SDK again.

-dontwarn com.geetest.gtcaptcha4.alicom.**
-keep class com.geetest.gtcaptcha4.alicom.**{*;}

If you use a resource obfuscation tool, add the following configuration to the whitelist:

"R.string.gt4_*",
"R.style.gt4_*",

Create a verification scheme

To use the SDK, you must obtain key parameters. Go to the Captcha Scheme Management console and create a new Captcha scheme to obtain the required appId and appKey parameters.

Configuration interface

Initialization

Initialize the SDK. Place the initialization code in the onCreate or onCreateView method.

public static AlicomCaptchaClient getClient(Context context);
public AlicomCaptchaClient init(String captchaId);
public AlicomCaptchaClient init(String captchaId, AlicomCaptchaConfig config)

Start validation

You can start the validation flow.

public void verifyWithCaptcha();

Cancel validation

You can cancel the validation flow and close the validation window.

public void cancel();

Enable or disable log monitoring

Call this method to enable or disable log printing for monitoring.

public void setLogEnable(boolean enable);

Get validation callbacks

public AlicomCaptchaClient addOnSuccessListener(OnSuccessListener listener);
public AlicomCaptchaClient addOnFailureListener(OnFailureListener listener);

Code example

AlicomCaptchaClient.addOnSuccessListener(new
AlicomCaptchaClient.OnSuccessListener() {
   @Override
   public void onSuccess(boolean status, String response) {
       if(status){
         // TODO: Enable secondary authentication.
       }else {
         // TODO: The user's answer is incorrect.
       }
   }
}).addOnFailureListener(new AlicomCaptchaClient.OnFailureListener() {
   @Override
   public void onFailure(String error) {
   }
})

Destroy resources

Destroy the resources in the onDestroy lifecycle method.

public void onDestroy(){
    super.onDestroy();
    if(AlicomCaptchaClient != null){
       AlicomCaptchaClient.destroy();
     }
}

Screen orientation change

@Override
public void onConfigurationChanged(Configuration newConfig) {
    super.onConfigurationChanged(newConfig);
    if(AlicomCaptchaClient != null){
       AlicomCaptchaClient.configurationChanged(newConfig);
    }
}

@Override
public void onViewCreated(View view, Bundle savedInstanceState){
   super.onViewCreated(view, savedInstanceState);
   AlicomCaptchaConfig config = new AlicomCaptchaConfig.Builder()
            .setDebug(true) // TODO: Make sure to disable this in production.
            .setLanguage("zh")
            .setTimeOut(10000)
            .setCanceledOnTouchOutside(true)
            .build();
   AlicomCaptchaClient = AlicomCaptchaClient.getClient(activity)
            .init("your captcha_id", config);
}

private void click(){
    AlicomCaptchaClient.addOnSuccessListener(new
AlicomCaptchaClient.OnSuccessListener {
             @Override
             public void onSuccess(boolean status, String response) {
                 if(status){
                     // TODO: Enable secondary authentication.
                 }else {
                    // TODO: The user's answer is incorrect.
                 }
             }
   })
   .addOnFailureListener(new AlicomCaptchaClient.OnFailureListener {
       @Override
       public void onFailure(String error) {
       }
   })
   .verifyWithCaptcha();
}

private void click(){
    AlicomCaptchaConfig config = new AlicomCaptchaConfig.Builder()
             .setDebug(true) // TODO: Make sure to disable this in production.
             .setLanguage("zh")
             .setTimeOut(10000)
             .setCanceledOnTouchOutside(true)
             .build();
   AlicomCaptchaClient = AlicomCaptchaClient.getClient(activity)
             .init("your captcha_id", config)
             .addOnSuccessListener(new AlicomCaptchaClient.OnSuccessListener {
                 @Override
                 public void onSuccess(boolean status, String response) {
                    if(status){
                        // TODO: Enable secondary authentication.
                    }else {
                        // TODO: The user's answer is incorrect.
                    }
              }
   })
   .addOnFailureListener(new AlicomCaptchaClient.OnFailureListener {
                 @Override
                 public void onFailure(String error) {
                 }
   })
   .verifyWithCaptcha();
}

Parameter settings

You can configure parameters using the AlicomCaptchaConfig.Builder class.