设备风险SDK Android接入

前提条件

设备风险SDK需在Android 4.0.3+（minSdkVersion版本15+）以上版本的系统运行。

合规指南

1、您需要确保App有《隐私政策》，并且在用户首次启动App时就弹出《隐私政策》取得用户同意，请勿默认客户已勾选。

2、您务必在《隐私政策》中向用户告知使用阿里云设备风险识别SDK，参考条款如下：

• 使用SDK名称：阿里云设备风险识别SDK；

• 服务类型：检测篡改设备、模拟器、恶意脚本等异常设备 ；

• 收集设备信息：

  • 设备基础信息：设备制造商、设备品牌、设备型号、设备名称、设备操作系统信息、设备配置信息、设备环境信息；

  • 设备标识信息：IMEI（国际移动设别码）、IMSI（国际移动用户识别码）、MAC地址、ICCID（集成电路卡识别码）、AndroidId、硬件序列号、OAID、Google AID（Google广告ID）、蓝牙MAC、IDFA、IDFV；

  • 设备网络信息：IP地址、WIFI信息、BSSID、SSID、网络运营商信息、网络类型、网络状态；

  • 其他信息：SDK宿主App信息（包括：应用名称、应用版本、安装时间）；

• 隐私政策链接：https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud202111120818_92724.html

3、您务必确保用户同意《隐私政策》之后，再初始化阿里云设备风险识别SDK。

权限说明

为增强风险识别效果，当前SDK需要以下权限：

下载和配置SDK

1. 下载Android SDK，并完成解压。SDK为Android标准的.aar包。

2. 拷贝SDK的aar文件到工程的libs目录下，并在App的build.gradle中添加以下依赖关系：

// 设备风险识别SDK
implementation files('libs/Android-AliyunDevice-版本号.aar')

// 三方网络库依赖
implementation 'com.squareup.okhttp3:okhttp:3.11.0'
implementation 'com.squareup.okio:okio:1.14.0'

注意：三方网络库不能省略，否则会造成设备风险识别SDK无法联网。

初始化SDK

完成SDK内部初始化，在App启动的时候，您需要尽可能早的调用该函数 。

• 函数原型

public interface SecurityInitListener {
    // code表示接口调用状态码
    void onInitFinish(int code);
}

public void init(Context ctx, 
                 String appKey, 
                 SecurityInitListener securityInitListener);

• 参数

ctx：当前Application Context，或Activity Context。

appKey：用于标识用户身份，可在阿里云控制台的设备App管理申请获取。

securityInitListener：设备风险SDK初始化回调接口，可在回调中判断初始化是否成功。其中，code字段取值范围可参考“状态返回值”。

• 返回值

无。

获取客户端Token

获取客户端Token，并上报到业务服务器，后续通过服务器端查询阿里云设备风险识别接口，从而获取设备风险信息。

• 函数原型

public class SecurityToken {
    // 接口调用状态码
    public int code;
    
    // 用于服务器端查询结果的token字符串。
    public String token;
}

public SecurityToken getDeviceToken();

• 返回值

SecurityToken类型。

code：返回接口调用状态码，可用于判断接口调用是否成功。code字段取值范围可参考“状态返回值”。

token：返回客户端Token字符串信息，可用于业务后续查询阿里云设备风险识别接口。

注意（非常重要）：

1. getDeviceToken接口相对比较耗时，请务必在App非主线程上调用，否则可能会引起ANR而导致App Crash。

2. 因为数据上报可能存在延迟，请确保SDK的init接口和getDeviceToken接口调用时间能间隔2秒以上。

3. Token字符串在网络环境良好的场景下，长度为600字节左右；在网络环境较差的场景下，返回的长度在2.5K左右。

状态返回值

示例代码

初始化设备风险SDK，init接口需要在App启动尽可能早的时候调用。

其中，参数ALIYUN_APPKEY用于标识用户身份，可在阿里云控制台的设备App管理申请获取。

public class CustomApplication extends Application {
    private static String ALIYUN_APPKEY = "xxxx";

    @Override
    public void onCreate() {
        super.onCreate();

        // 初始化设备风险SDK，init接口需要在APP启动尽可能早的时候调用。
        SecurityDevice.getInstance().init(this, ALIYUN_APPKEY, null);
    }
}

在业务需要风险识别的场景下（如注册、活动推广等）获取户端Token并上报到业务的服务器端。确保init和getDeviceToken接口的调用间隔在2秒以上。

另外，getDeviceToken接口比较耗时，切勿在UI线程中调用。

new Thread() {
    @Override
    public void run() {
        SecurityToken st = SecurityDevice.getInstance().getDeviceToken();
        if(null != st){
            if(SecurityCode.SC_SUCCESS == st.code){
                Log.d("AliyunDevice", "token: " + st.token);

                // 发送token到业务自有服务器并查询阿里云设备风险识别接口。
                // sendToAPPServer(st.token);
            } else {
                Log.e("AliyunDevice", "getDeviceToken error, code: " + st.code);
            }
        } else {
            Log.e("AliyunDevice", "getDeviceToken is null.");
        }
    }
}.start();

接口混淆配置

-keep class net.security.device.api.** {*;}
-dontwarn net.security.device.api.**

调用风险识别API接口

将deviceToken与其他参数，根据如下相应的风险识别服务事件参数文档说明，请求风险识别API接口进行识别：

注册风险识别功能及参数说明

营销风险识别功能及参数说明

登录风险识别功能及参数说明

设备风险识别事件及返回参数

接入和使用时序图如下，其中第1和2步骤仅首次加载需要调用，第3、4、5、6、7、8、9步骤可以根据业务情况循环发起。

常见问题答疑

1. 设备风险识别SDK支付哪些架构？

目前支持arm、armv7和arm64三个架构。

2. SDK的大小是多少？

单架构的SO文件在1.8M左右。

设备风险识别SDK为了保证自身的抗逆向性以及数据在网络传输过程中的安全性，SDK中有大量的插花、膨胀及加解密操作，所以SDK体积会相对较大。

3. 为什么获取的token这么长？

正常情况下token的长度在600字节左右，2.5K以上的长token只会出现在网络较差的场景下。

如果业务上出现了大量的长token，首先请确保客户端的网络是畅通的；其次，请确保SDK的init接口和getDeviceToken接口调用能间隔2秒以上。