集成要求
合规说明
请注意,在贵司的App中集成同盾提供的SDK产品时:
1.1 根据《网络安全法》《电信条例》《电信和互联网用户个人信息保护规定》等相关法律法规要求及监管实践中的标准,在贵司的最终用户首次启动App并在贵司开始采集信息之前,贵司应以交互界面或设计(如隐私政策弹窗等)向最终用户完整告知收集、使用、与第三方共享最终用户个人信息的目的、方式和范围,并征得最终用户的明示同意。
1.2 为向贵司提供业务安全和风控服务,同盾SDK将采集、处理、使用用户的手机终端唯一标志信息(IMEI/IDFA)、Android ID、OAID、IMSI、MEID、MAC 地址、SIM 卡序列号、设备序列号、设备类型、设备型号、系统类型、地理位置、登录 IP 地址等设备信息。为确保贵司使用相关服务的合规性,前述隐私政策应涵盖对同盾SDK提供服务并采集、处理、使用相关信息的授权,以下条款内容供贵司参考,具体表述可由贵司根据贵司隐私协议的整体框架和内容自行确定:
同盾SDK:为了业务安全和风控,我司使用了同盾 SDK,该 SDK 需要获取您的手机终端唯一标志信息(IMEI/IDFA)、Android ID、OAID、IMSI、MEID、MAC 地址、SIM卡序列号、设备序列号、设备类型、设备型号、系统类型、地理位置、登录 IP 地址、应用程序列表、运行中进程信息、传感器(光传感器、重力传感器、磁场传感器、加速度传感器、陀螺仪传感器、心率传感器)相关设备信息,用于设备欺诈风险识别。 |
同盾隐私协议:https://www.tongdun.cn/other/privacy/id=1
环境要求
说明 | |
---|---|
兼容版本 | API11及以上系统 |
支持架构 | arm64-v8a, x86_64 |
集成步骤
安装配置
获取 SDK
请联系同盾运营获取 SDK 包
集成 SDK
在工程的 oh-package.json5 中设置三方包依赖,配置示例如下:
"dependencies": {
"@ohos/mobrisk": "file:./mobrisk-1.0.6.har"
}
权限声明
在工程的 module.json5 中声明以下权限:
<!--必选权限-->
ohos.permission.INTERNET
ohos.permission.GET_NETWORK_INFO
ohos.permission.GET_WIFI_INFO
ohos.permission.STORE_PERSISTENT_DATA
权限说明
权限 | 说明 |
---|---|
ohos.permission.INTERNET(必选) | 允许程序访问网络连接,发送请求与服务器进行通信 |
ohos.permission.GET_NETWORK_INFO(必选) | 获取网络连接状态信息 |
ohos.permission.GET_WIFI_INFO(必选) | 获取当前 WiFi 接入的状态以及 WLAN 热点的信息 |
ohos.permission.STORE_PERSISTENT_DATA(必选) | 允许应用在用户卸载时保留持久化数据 |
初始化
方法定义
/**
* 设备指纹初始化
* @param context 上下文
* @param params 初始化参数
*/
public static async initWithOptions(context: Context, params: TDRiskOption): Promise<void>
获取blackBox
注意事项
- 请在 initWithOptions 后调用 getBlackBox
- 不要在 App 内对返回的 blackBox 进行缓存,获取 blackBox 请依赖 getBlackBox 方法
方法定义
/**
* 获取blackbox
* @param callback 回调blackbox函数
* @param priorityCache blackbox获取优先级, 默认false
* false: 等待数据上报完成后, 返回blackbox
* true: 发起数据上报后, 优先使用上一次生成的blackbox, 立即返回
*/
public static async getBlackBoxAsync(priorityCache: boolean = false): Promise<string>
最佳实践
- 在应用首次加载时的 onCreate 方法中调用初始化并异步获取 blackBox
import AbilityStage from '@ohos.app.ability.AbilityStage';
import { TDRisk, TDRiskOption } from '@ohos/mobrisk';
export default class MyAbilityStage extends AbilityStage {
async onCreate() {
// 应用的HAP在首次加载的时,为该Module初始化操作
const options: TDRiskOption = {
/*************************** 必传 ***************************/
partnerCode: 'demo', // 同盾的合作⽅编码,请填写⾃身的合作⽅编码
appKey: 'appKey', // 配置AppKey,请联系同盾运营获取
country: TDRisk.COUNTRY_CN, // 国家地区参数,列表可以参考下文全部配置说明
/*************************** 必传 ***************************/
}
if (⽤户同意隐私协议) {
await TDRisk.initWithOptions(this.context, options)
const blackbox = await TDRisk.getBlackBoxAsync()
console.log('TD_TS', `init & get success blackbox:${blackbox}`)
}
}
}
- 在实际业务节点获取 blackbox
// 比如注册的时候
async function register(): Promise<void> {
// ...
const blackbox = await TDRisk.getBlackBoxAsync(true)
console.log('TD_TS', `get blackbox:${blackbox}`)
//...
}
状态检查
- 初始化成功会在 logcat 中打印以下日志:
TD_TS: td sdk init success
- SDK 上报数据成功,getBlackBoxAsync()返回的结果长度为26位字符串。
- 异常情况下,getBlackBoxAsync()返回的结果长度可能达到5000字符,详情可查看正常blackBox和降级blackBox的差异
其他说明
获取版本号
TDRisk.getSDKVersion()
全部配置
配置 key | 说明 | 示例代码 |
---|---|---|
partnerCode(必须) | 合作方编码,请联系运营获取 | options["partnerCode"] = "请输入您的合作方编码" |
appKey(必须) | 应用标识,提供 App 的包名 bundleName 后联系运营获取 appKey bundleName 获取方式:AppScope/app.json5 内 bundleName 对应的 value | options["appKey"] = "请输入您的appKey" |
country(必须) | 数据中心地区: TDRisk.COUNTRY_US(北美) TDRisk.COUNTRY_FRA (欧洲) TDRisk.COUNTRY_SG (新加坡) TDRisk.COUNTRY_IDNA (印尼) TDRisk.COUNTRY_CN (中国) | options["country"] = "请输入您所在的国家地区" |
appName | 应用名称,请联系运营获取 | options["appName"] = "请输入您的appName" |
disableGPS | 禁止采集 GPS 位置信息,默认允许 | options["disableGPS"] = true |
customMessage | 自定义消息,SDK 支持透传和存储 | options["customMessage"] = "customMessage" |