API Reference
English

Android

集成要求

中国大陆合规指导说明

请注意,在贵司的App中集成同盾提供的SDK产品时:

1.1 根据《网络安全法》《电信条例》《电信和互联网用户个人信息保护规定》等相关法律法规要求及监管实践中的标准,在贵司的最终用户首次启动App并在贵司开始采集信息之前,贵司应以交互界面或设计(如隐私政策弹窗等)向最终用户完整告知收集、使用、与第三方共享最终用户个人信息的目的、方式和范围,并征得最终用户的明示同意。
1.2 为向贵司提供业务安全和风控服务,同盾SDK将采集、处理、使用用户的手机终端唯一标志信息IDFA、Android ID、OAID(包含VAID、AAID)、MAC 地址、WIFI列表、无线路由器标识(BSSID、SSID)、设备类型、设备型号、系统类型、位置信息(粗略位置信息、精准位置信息)、应用程序列表、运行中进程信息、网络制式、设备软件版本号、传感器(光传感器、重力传感器、磁场传感器、加速度传感器、陀螺仪传感器、心率传感器)相关设备信息。为确保贵司使用相关服务的合规性,前述隐私政策应涵盖对同盾SDK提供服务并采集、处理、使用相关信息的授权,以上内容供贵司参考,具体表述可由贵司根据贵司隐私协议的整体框架和内容自行确定。

SDK信息

SDK名称:同盾设备指纹SDK
开发者名称:同盾科技有限公司 使用目的:提供业务安全和风控服务 包名: com.trustdecision.mobrisk MD5值:fab66da8824f0fd4a469cac59f3e96e7 版本号:5.1.0 个人信息类处理规则(隐私政策)https://www.tongdun.cn/other/privacy/id=4 使用说明合规使用指导

Google Play 的数据安全要求

对于上传到 Google Play 商店的每款应用,Google 都要求向所有用户公开应用的隐私和安全做法。因此,当应用(或新版本)上传到 Play 商店时,Google 要求应用开发者填写数据安全表单。有关详细信息,请参阅为 Google Play 的数据安全部分提供信息。

如果您的应用包含我们的Android SDK,那么您可以使用下表作为参考来填写数据安全表单:

Google Play 控制台数据安全表单中的问题回复
您的应用是否收集或共享任何所需的用户数据类型?是的
收集什么类型的数据?设备或其他标识符
这些数据是被收集、共享,还是两者兼而有之?收集
这些数据是暂时处理的吗?是的
为什么要收集这些用户数据?欺诈预防、安全和合规

环境要求

说明
兼容版本Android 5.0及以上系统
支持架构armeabi-v7a, arm64-v8a, x86, x86_64

集成步骤

添加仓库

在项目根目录的 build.gradle加入maven库的配置

allprojects {
    repositories {
        ...
        mavenCentral()
    }
}

如果您的 Gradle 版本是 7 或更高版本,请将下方配置添加到工程的 settings.gradle

repositories {
    ...
    mavenCentral()
}

添加依赖

在应用主模块的 build.gradle 中,声明SDK包依赖

dependencies {
    implementation 'com.trustdecision.android:mobrisk:5.1.0'
 }

如果遇到合规性问题,可以在依赖阶段排除相关模块的采集

dependencies {
    // 设备指纹
    implementation('com.trustdecision.android:mobrisk:5.1.0'){
    		
      	// 移除后sdk不获取安装包列表
        exclude group: 'com.trustdecision.android', module: 'packagelist'
        // 移除后sdk不会收集READ_PHONE_STATE相关信息
        exclude group: 'com.trustdecision.android', module: 'readphone'
        // 移除后sdk不会收集地理位置相关信息
        exclude group: 'com.trustdecision.android', module: 'location'
       	// 移除后sdk不会收集传感器相关信息
        exclude group: 'com.trustdecision.android', module: 'sensor'
      	 // 移除后sdk不会收集wifi相关信息
        exclude group: 'com.trustdecision.android', module: 'wifiinfo'
    }
 }

配置ABI类型

SDK目前支持armeabi-v7a、arm64-v8a、x86、x86_64等ABI类型,建议接入方在主模块build.gradle文件内添加 abiFilters配置选择所需要的架构类型,具体架构,请以您自己需要支持的架构为准!

defaultConfig {
    ...
    ndk {
       abiFilters 'armeabi-v7a', 'arm64-v8a'
    }
}

配置AndroidManifest.xml

在应⽤module下的 AndroidManifest.xml ⽂件中声明以下权限

<manifest>
   <!--必选权限-->
  
   <!--基础网络通信,数据收集完毕,上报时调用-->
   <uses-permission android:name="android.permission.INTERNET"/>
   <!--SDK加载后,数据采集完准备上报时调用-->
   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
   <!--SDK加载后,数据采集时调用-->
   <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
   <!--如果您的应用是面向海外市场,在google play 上发布,请添加此项-->
   <uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

   <!--以下权限是可选权限,不声明此部分权限将放弃部分设备信息的采集,对风险识别有一定影响-->
  
   <!--SDK加载后,数据采集时调用-->
   <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
   <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
   <uses-permission android:name="android.permission.READ_PHONE_STATE" />
   <!-- Android11及以上获取安装包列表需要该权限,采集安装包列表涉及到⻛险合规,是否需要该权限业务⽅⾃⾏选
择 -->
   <uses-permission android:name="android.permission.QUERY_ALL_PACKAGES"
        tools:ignore="QueryAllPackagesPermission" />
</manifest>

权限说明

权限说明
INTERNET(必选)允许程序访问网络连接,发送请求与服务器进行通信
ACCESS_NETWORK_STATE(必选)获取网络连接状态信息
ACCESS_WIFI_STATE(必选)获取当前WiFi接入的状态以及WLAN热点的信息
AD_ID(海外必选)获取google 广告ID
ACCESS_COARSE_LOCATION获取粗略位置信息,精度大概误差在30~1500米
ACCESS_FINE_LOCATION获取精确位置信息,定位精度达10米以内
READ_PHONE_STATE读取SIM卡相关信息
QUERY_ALL_PACKAGES获取应用程序列表

初始化

可以在APP启动时对SDK进行初始化,初始化不会采集任何数据。

方法定义

public static void initWithOptions(Context ctx, TDDeviceManager.Builder builder);

获取设备信息

注意事项

  • 请在initWithOptions后调用getDeviceInfo

方法定义

public static void getDeviceInfo(TDDeviceInfoCallback callback);

最佳实践

  1. 在应用入口Application的onCreate方法中加载
// 应用入口APPlication的onCreate
TDDeviceManager.Builder builder = new TDDeviceManager.Builder()
/*************************** 必传 ***************************/
.partner("demo")        // 合作⽅编码,请填写⾃身的合作⽅编码
.appKey("appKey")           // 配置AppKey,请联系同盾运营获取		 
.country(TDDeviceManager.COUNTRY_CN); // 国家地区参数,列表可以参考下文全部配置说明
/*************************** 必传 ***************************/

TDDeviceManager.initWithOptions(getApplicationContext(), builder);
  1. 在实际业务节点获取设备信息
TDDeviceManager.getDeviceInfo(new TDDeviceInfoCallback() {
    @Override
    public void onResult(String fpVersion,
                  String blackBox,
                  String anonymousId,
                  int deviceRiskScore,
                  TDDeviceAPIStatus apiStatus,
                  String sealedResult) {
        // 注:回调在子线程中执行,请不要在此处操作UI
        // fpVersion: SDK版本号
        // blackBox: 本次采集的blackBox
        // anonymousId: 当前设备的匿名ID
        // deviceRiskScore: 设备风险分数
        // apiStatus: API状态信息
        // sealedResult: 密封结果
        int code = apiStatus.getCode();
        // 成功
        if (code == 0) {
          //...
        }
        // 失败
        else {
          //...
        }      
    }
});

状态检查

  1. 加载成功会在 logcat中打印以下日志:
TD_JAVA: TD sdk load success
TD_JAVA: TD sdk init success
  1. 当getDeviceInfo() 回调的 code == 0 时即代表获取设备信息成功;

响应结果

getDeviceInfo() 函数会在 onResult 方法中返回响应数据,包含以下信息。sealedResult 仅在启用了客户端密封结果时返回该信息。

字段描述
anonymousId设备匿名ID,设备标识
blackBox调用日志查询标识
fpVersionSDK版本号
deviceRiskScore当前设备风险分
sealedResult加密的设备信息,二进制 Base64 编码字符串,仅在客户端密封结果开启时返回,解密结果与设备信息查询获取的信息一致,参考:设备调用日志

其他说明

获取版本号

TDDeviceManager.getSDKVersion();

混淆打包

如果开发者需要使用 proguard 进行混淆打包,请在 proguard 配置文件添加如下代码:

-keep class com.trustdecision.**{*;}

配置参数列表

配置 key说明示例代码移除字段
partner(必须)合作方编码,请联系运营获取builder.partner("your partnerCode")
appKey(必须)应用标识,参考如何申请appKeybuilder.appKey("appKey")
country(必须)数据中心地区:TDDeviceManager.COUNTRY_US(北美) TDDeviceManager.COUNTRY_FRA (欧洲) TDDeviceManager.COUNTRY_SG (新加坡) TDDeviceManager.COUNTRY_IDNA (印尼) TDDeviceManager.COUNTRY_CN (中国)builder.country(TDDeviceManager.COUNTRY_CN)
channel渠道标识,请联系运营获取builder.channel("channel")
httpTimeOut网络请求回调的超时时间,单位毫秒,默认15000builder.httpTimeOut(5000)
disableOptions禁止指定采集项1. 禁止采集OAID builder.disableOptions(TDDeviceManager.OPTION_OAID) 2. 禁止采集GAID builder.disableOptions(TDDeviceManager.OPTION_AID) 3. 禁止采集androidId builder.disableOptions(TDDeviceManager.OPTION_ANDROID_ID)oaid,gaid,androidId
disableRunningTasks禁止获取正在运行的任务,默认允许builder.disableRunningTasks()running_packages
disableGPS禁止采集GPS位置信息,默认允许builder.disableGPS()ssid、wifi_list、gps_switch、latitude、longitude、gps_location
disableSensor禁止采集传感器信息,默认允许builder.disableSensor()mangetic_field_sensor、gyroscope_sensor、light_sensor、accelerator_data、gravity_data
disableReadPhone禁止采集READ_PHONE_STATE权限相关信息,默认允许builder.disableReadPhone()country_iso、carrier、network_operator、sim_operator、phone_type、radio_type、device_svn
enableWifiMac开启采集WIFI MAC地址, 默认不采集builder.enableWifiMac()wifi_mac
disableInstallPackageList禁止采集应用列表信息,默认采集builder.disableInstallPackageList()installed_packages
customMessage自定义消息,sdk支持透传和存储builder.customMessage(customMessage)

状态码说明

调用TDDeviceManager.getDeviceInfo()方法,回调中TDDeviceAPIStatus类型的参数保存着SDK的状态信息,它的定义如下:

public class TDDeviceAPIStatus {
    public TDDeviceAPIStatus(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }

    private int code;
    private String message;
}

code和message对应值如下表:

codemessage备注
0Success.成功
1000Invalid  parameters.传入的参数无效
1001SDK error.SDK 发生异常,可能原因: * 未调用初始化函数 * so文件加载失败
1002Network error.网络错误
1003API error.后端接口返回错误
1004Traffic limit.网关限流