在工程中導入SDK

在控制臺成功上傳APK包后，您可以下載并獲取到一個名為阿里云認證SDK-ANDROID.zip的ZIP壓縮包。

關于SDK包

解壓ZIP包后，您將看到一系列SDK相關的依賴包，下表介紹了這些SDK包、文件的說明。其中，xxx表示版本號。

解壓出SDK依賴包后，建議在工程根目錄下創建目錄libs（已有則忽略），根據上述介紹將SDK包拷入工程的libs目錄下。

同時，解壓出jniLibs.zip壓縮包內容后，需要將內容拷至src/main/jniLibs（默認JNI依賴SO文件目錄）下。

在工程中集成SDK

添加SDK包依賴

以直接在應用下進行集成為例，在應用module下的build.gradle文件內，聲明flatDir路徑（如果已有則忽略）：

apply plugin: 'com.android.application'

repositories {
  flatDir {
    dirs '../libs'
  }
}

以gradle版本大于等于3.0.0（非gradle tools版本，gradle版本可在gradle/wrapper/gradle-wrapper.properties下查看）為例，在應用module下的build.gradle文件內聲明SDK包依賴：

dependencies {
    implementation fileTree(dir: '../libs', include: ['*.jar'])
    implementation (name:'rpsdk-4.13.2', ext:'aar')
    implementation (name:'SecurityGuardSDK-external-release-5.5.15071059', ext:'aar')
    implementation (name:'SecurityBodySDK-external-release-5.5.15071314', ext:'aar')
    implementation (name:'MiddleTierSDK-external-release-5.5.13874142', ext:'aar')
}

關于ABI類型

android {
      defaultConfig {
            ndk {
                abiFilters "armeabi-v7a", "arm64-v8a"
            }
    }
}

關于簽名配置

實人認證SDK要求必須存在V1簽名，否則實人認證SDK無法正常工作。關于如何檢測APK是否存在V1簽名，請參考官方文檔檢查apk是否包含V1簽名。

 v1SigningEnabled true

關于混淆配置

如果您的應用使用了ProGuard進行代碼混淆，為了保證實人認證服務需要的一些類不被混淆，需要在ProGuard配置文件中添加相關指令。

android {
    ...
    buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

-keep class com.alibaba.security.**{*;}
-keep class com.taobao.dp.**{*;}
-keep class com.taobao.wireless.security.**{*;}
-keep class com.alibaba.wireless.security.**{*;}
-keep class android.taobao.windvane.**{*;}
-keep class android.webkit.JavascriptInterface

<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@drawable/yw_1222_*, @layout/rp_*, @drawable/rp_*" />

目前暫未支持gradle plugin version為7.0及以上版本。

如果您想了解關于資源壓縮的更多內容，請參見Andriod官方文檔Shrink your app。其中，《壓縮資源》章節介紹了如何使用shrinkResources壓縮資源、配置keep.xml、自定義要保留的資源。更多內容，請參見壓縮資源。

關于權限配置

<uses-permission android:name="android.permission.CAMERA"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

Sample示例工程

壓縮包內包含了可參考的樣例工程（目錄是Sample）。打上TODO標簽的內容表示接入時需要注意的點。請您按照TODO標簽的注意點，修改您業務的包名、簽名和安全圖片后，加上token就可以正常運行該工程。

使用SDK

初始化

import android.app.Application;
import android.content.Context;

import com.alibaba.security.realidentity.RPVerify;

public class DemoApplication extends Application {
    private Context appContext;

    @Override
    public void onCreate() {
        super.onCreate();
        appContext = this.getApplicationContext();
        // 初始化實人認證SDK。
        RPVerify.init(appContext);
    }
}

上述寫法并不是必須的，您可以在調用RPVerify其他接口前的任意位置調用初始化，但為了方便維護和管理，建議您按照示例操作。

調用實人認證

調用開始實人認證的接口前，需要您提前獲取verifyToken（verifyToken由您的服務端調用發起認證請求接口DescribeVerifyToken獲取），將其傳入接口。

RPVerify.start(DemoActivity.this, "", new RPEventListener() {
      @Override
      public void onFinish(RPResult auditResult, String code, String msg) {
        if (auditResult == RPResult.AUDIT_PASS) {
              // 認證通過。建議接入方調用實人認證服務端接口DescribeVerifyResult來獲取最終的認證狀態，并以此為準進行業務上的判斷和處理。
              // do something
        } else if (auditResult == RPResult.AUDIT_FAIL) {
              // 認證不通過。建議接入方調用實人認證服務端接口DescribeVerifyResult來獲取最終的認證狀態，并以此為準進行業務上的判斷和處理。
              // do something
        } else if (auditResult == RPResult.AUDIT_NOT) {
              // 未認證，具體原因可通過code來區分（code取值參見錯誤碼說明），通常是用戶主動退出或者姓名身份證號實名校驗不匹配等原因，導致未完成認證流程。
              // do something
        }
      }
});

RPVerify.startByNative(DemoActivity.this, "", new RPEventListener() {
    @Override
      public void onFinish(RPResult auditResult, String code, String msg) {
        Toast.makeText(DemoActivity.this, auditResult + "", Toast.LENGTH_SHORT).show();

        if (auditResult == RPResult.AUDIT_PASS) {
              // 認證通過。建議接入方調用實人認證服務端接口DescribeVerifyResult來獲取最終的認證狀態，并以此為準進行業務上的判斷和處理。
              // do something
        } else if (auditResult == RPResult.AUDIT_FAIL) {
              // 認證不通過。建議接入方調用實人認證服務端接口DescribeVerifyResult來獲取最終的認證狀態，并以此為準進行業務上的判斷和處理。
              // do something
        } else if (auditResult == RPResult.AUDIT_NOT) {
              // 未認證，具體原因可通過code來區分（code取值參見錯誤碼說明），通常是用戶主動退出或者姓名身份證號實名校驗不匹配等原因，導致未完成認證流程。
              // do something
        }
      }
});

無論是start接口還是startByNative接口，在開始實人認證的接口中，verifyToken參數由接入方的服務端調用實人認證服務的DescribeVerifyToken接口獲得。

錯誤碼說明

UI定制

實人認證服務為您提供UI定制功能，您可以根據實際需要自定義實人認證頁面的按鈕顏色、文案顏色、文案字體大小和圖片資源等信息。UI定制功能僅適用于實人認證Android SDK版本在4.6.2版本及以上。更多內容，請參見UI定制。

// 設置UI自定義皮膚路徑。
public RPConfig.Builder setSkinPath(String path);
// 設置皮膚是否內置。
public RPConfig.Builder setSkinInAssets(boolean b);

自定義配置

• 設置可配置項

  可通過RPConfig.Builder創建一個RPConfig類實例。

  // 退出彈框是否需要確認。
  public RPConfig.Builder setShouldAlertOnExit(boolean shouldAlertOnExit);
  // 轉場動畫。
  public RPConfig.Builder setTransitionMode(TransitionMode transitionMode);
  // 是否需要聲音。
  public RPConfig.Builder setNeedSound(boolean needSound);

• 傳入配置項

  可通過初始化接口設置你需要的UI樣式。

  RPVerify.start(android.content.Context, String verifyToken, com.alibaba.security.realidentity.RPConfig config, RPEventListener listener)

常見問題

請參見Android集成常見問題。