Android集成

在工程中导入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集成常见问题。