更新记录

1.2.1（2024-02-07）

1.iOS 升级到 4.2.6.3 版本设备指纹库； 2.Android 升级 4.3.1.3 版本设备指纹库；

平台兼容性

原生插件通用使用流程：

1. 购买插件，选择该插件绑定的项目。
2. 在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
3. 根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
4. 打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

集成要求

合规说明

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

1.1 根据《网络安全法》《电信条例》《电信和互联网用户个人信息保护规定》等相关法律法规要求及监管实践中的标准，在贵司的最终用户首次启动App并在贵司开始采集信息之前，贵司应以交互界面或设计（如隐私政策弹窗等）向最终用户完整告知收集、使用、与第三方共享最终用户个人信息的目的、方式和范围，并征得最终用户的明示同意。

1.2 为向贵司提供业务安全和风控服务，同盾SDK将采集、处理、使用用户的手机终端唯一标志信息（IMEI/IDFA）、Android ID、IMSI、MEID、MAC 地址、SIM 卡序列号、设备序列号、设备类型、设备型号、系统类型、地理位置、登录 IP 地址等设备信息。为确保贵司使用相关服务的合规性，前述隐私政策应涵盖对同盾SDK提供服务并采集、处理、使用相关信息的授权，以下条款内容供贵司参考，具体表述可由贵司根据贵司隐私协议的整体框架和内容自行确定：

同盾隐私协议：https://www.tongdun.cn/other/privacy/id=1

注意事项

确保在用户同意隐私协议后，再进行插件配置初始化，避免出现用户未同意隐私协议就进行插件初始化采集，引发合规风险。

集成步骤

集成SDK

1. 把TrustDeviceUniPlugin 文件夹放入 your_project/nativeplugins 目录
2. 在 HBuilderX 点击选中 manifest.json，选择 App原生插件配置
3. 点击本地插件 [选择本地插件]，勾选 TrustDeviceUniPlugin

Android权限申请

在工程目录下的 manifest.json ⽂件中声明以下权限

"android" : {
                "permissions" : [
                    "<uses-permission android:name=\"android.permission.ACCESS_NETWORK_STATE\"/>",
                    "<uses-permission android:name=\"android.permission.ACCESS_WIFI_STATE\"/>",
                    "<uses-permission android:name=\"android.permission.INTERNET\"/>"
                ],
            ...
            },

SDK初始化

示例代码

methods: {
initTrustDevice() {
    var options = {
        "partner": "tongdun",
        "appKey": "9b8bcadf9458119604336bb9ab0b8f8a",
        "appName": "demo",
        "country": "cn",
    }

    // !!! DEBUG模式下若不设置此参数，app运行会闪退
    if (process.env.NODE_ENV === "development") {
        options["debug"] = true
    }

    TrustDeviceUniPlugin.initWithOptions(options)
},
}

必传配置

获取SDK版本号

示例代码

methods: {
    getSDKVersion() {
        var ret = TrustDeviceUniPlugin.getSDKVersion();
        console.log("SDK version: " + ret)
    }
}

设备指纹功能模块

initWithOptions选传参数

获取blackbox

同步方法 getBlackBox

使用场景说明

优点： 会立即返回blackBox，不受网络状态的影响；
缺点： 在集成设备指纹SDK后，在之前没有获取到非降级blackBox的情况下，会返回降级blackBox，会增大后续查询接口上传的数据量，数据量大小为5000字节左右；
适用场景： 需要立即获取blackBox的场景；

示例代码

getBlackBox() {
    var ret = TrustDeviceUniPlugin.getBlackBox();
    console.log("getBlackBox,blackBox: "+ret)
},

异步方法 getBlackBoxAsync

使用场景说明

优点： 网络正常情况下返回非降级blackBox，会降低后续查询接口上传的数据量，数据量大小为26字节左右；
缺点： 不是立即返回，根据网络情况进行等待，一般耗时300ms左右返回；
适用场景： 需要获取最新且为非降级blackBox的场景；

示例代码

getBlackBoxAsync() {
     TrustDeviceUniPlugin.getBlackBoxAsync(ret => {
          console.log("getBlackBoxAsync,blackBox: "+ret)
    })
},

验证码功能模块

initWithOptions选传参数

弹出验证码弹窗

示例代码

showCaptcha() {     
    this._showCaptcha({
    onReady: function() {
      console.log("验证码弹窗成功，等待验证!");
    },
    onSuccess: function(token) {
      console.log("验证成功!，validateToken:", token);
    },
    onFailed: function(errorCode, errorMsg) {
      console.log("验证失败，错误码:", errorCode, ",错误内容:", errorMsg);
    }
  })
  },

错误码

验证码功能模块的错误码会通过 showCaptcha 函数输出

FAQ

Q1：引入终端SDK后，工程无法再进行 Xcode 调试，如何解决？

A1：请参考 SDK初始化 在终端SDK初始化时，加入如下参数

options["debug"] = true