集成要求

合规说明

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

环境要求

条目	说明
兼容版本	iOS9.0+
支持架构	armv7, arm64, x86_64

1.集成SDK

CocoaPods集成

在 Podfile 文件中对应 target 中新增 pod 'TrustDecisionPro', '5.2.5.1'
在 Podfile 文件中对应 target 中新增 pod 'TrustDecisionBehavior', '1.3.0'
在 Podfile 所在文件夹中执行 pod install --repo-update 命令 (M1系列mac电脑需要执行 arch -x86_64 pod install --repo-update 命令)

SDK目录

Pods/TrustDecisionPro 文件夹下存在如下文件:

TDMobRisk.xcframework（终端SDK主文件，静态库类型）
FMDeviceManagerFramework.xcframework （设备指纹SDK，静态库）
TDCorePlugin.xcframework （终端SDK依赖核心插件，Embed动态库类型）

Pods/TrustDecisionBehavior 文件夹下存在如下文件:

TDBehavior.xcframework（终端SDK 行为采集组件，静态库类型）

引入头文件

在调用的位置引入头文件

#import <TDMobRisk/TDMobRisk.h>

import TDMobRisk

2.SDK初始化

注意事项

安装后首次启动时，在用户同意隐私协议后，再进行SDK初始化。

避免出现用户未同意隐私协议就进行SDK初始化采集，引发合规风险事故。

接口定义

void (*initWithOptions)(NSDictionary *options);

initWithOptions方法必传配置

配置 key	定义	说明	示例代码
partner	合作方编码	同盾的合作方编码 partner code，请联系同盾运营获取	Objective C [options setValue:@"请输入您的合作方编码" forKey:@"partner"]; Swiftoptions.updateValue("请输入您的合作方编码" , forKey: "partner")
appKey	应用标识	应用标识，参考如何申请appKey	Objective C [options setValue:@"请输入您的appKey" forKey:@"appKey"]; Swiftoptions.updateValue("请输入您的appKey" , forKey: "appKey")
country	国家地区	根据国家地区填写对应参数。 cn 代表中国， sg 代表新加坡， us代表北美， fra代表欧洲，idna代表印尼	Objective C [options setValue:@"请输入您所在的国家地区" forKey:@"country"]; Swiftoptions.updateValue("请输入您所在的国家地区" , forKey: "country")

示例代码

- (void)initTrustDeviceSDK {
  TDMobRiskManager_t *riskManager = [TDMobRiskManager sharedManager];
  NSMutableDictionary *options = [NSMutableDictionary dictionary];
  /*************************** 必传 ***************************/
  // 合作方编码，如tongdun，参考`必传配置`
  [options setValue:@"请输入您的partnerCode" forKey:@"partner"];
    // 平台注册的应用标识，参考`必传配置`
  [options setValue:@"请输入您的appKey" forKey:@"appKey"];
  // 国家地区参数，参考`必传配置`
  [options setValue:@"请输入您所在的国家地区" forKey:@"country"];
  /*************************** 选传 ***************************/
#ifdef DEBUG
  // !!! DEBUG模式下若不设置此参数，app运行会闪退
  [options setValue:@(YES) forKey:@"allowed"];
#endif
  riskManager->initWithOptions(options);
}

func initTrustDecisionSDK() {
  let riskManager = TDMobRiskManager.sharedManager()
  var options = Dictionary<String, Any>()
  /*************************** 必传 ***************************/
  // 合作方编码，如tongdun，参考`必传配置`
  options.updateValue("请输入您的partnerCode", forKey: "partner")
    // 平台注册的应用标识，参考`必传配置`
  options.updateValue("请输入您的appKey", forKey: "appKey")
  // 国家地区参数，参考`必传配置`
  options.updateValue("请输入您所在的国家地区", forKey: "country")
  /*************************** 选传 ***************************/
#if DEBUG
  // !!! DEBUG模式下若不设置此参数，app运行会闪退
  options.updateValue(true, forKey: "allowed");
#endif
  riskManager?.pointee.initWithOptions(options)
}

3.调用行为采集方法，获取 payload

行为采集方法用于获取用户行为数据，其接口定义如下：

typedef struct _TDBehaviorResultStruct{
    // 返回码，0代表成功
    const NSInteger code;
    // 行为采集数据
    char* const payload;
    // 失败时的错误信息
    char* const msg;
}TDBehaviorResultStruct;

/**
* TDBehavior start，开始行为采集，将采集数据写入SDK内部容器中
*/
void (*start)(void);
    
/**
* TDBehavior stop，结束行为采集，停止将采集数据写入SDK内部容器中
*/
void (*stop)(void);
/**
* TDBehavior collect，返回行为采集结果，如果SDK内部容器中存在数据，则会返回成功code == 0，同时清空SDK内部容器中的数据；
* 如果SDK内部容器中不存在数据则返回code == 104 错误码
*/
TDBehaviorResultStruct (*collect)(void);

示例代码

⚠️⚠️⚠️ 确保在业务界面调用start之后，存在用户行为，例如：文字输入、点击、

滑动等，否则调用 collect 会返回104错误码，表示没有采集到行为数据；

    TDMobRiskManager_t *manager = [TDMobRiskManager sharedManager];
    // 在进入业务界面时，调用 start方法，进行行为采集，例如进入登录界面时
    manager->start();
    ...
    // 在调用业务接口时，调用 collect方法，获取行为采集数据，例如点击登录按钮
    TDBehaviorResultStruct resultStruct = manager->collect();
    NSInteger code = resultStruct.code;
    char* msg = resultStruct.msg;
    char* payload = resultStruct.payload;
    if (code == 0){
        NSLog(@"获取行为采集结果成功，payload:%s",payload);
    }else{
        NSLog(@"获取行为采集结果失败，code:%ld,msg:%s",code,msg);
    }
    ...
    // 离开业务界面时，调用 stop方法，结束行为采集，例如离开登录界面时
    manager->stop();

    let manager = TDMobRiskManager.sharedManager()
    // 在进入业务界面时，调用 start方法，进行行为采集，例如进入登录界面时
    manager?.pointee.start();
    ...
    // 在调用业务接口时，调用 collect方法，获取行为采集数据，例如点击登录按钮
    let resultStruct = manager?.pointee.collect()
    let code = resultStruct!.code
    let msg = resultStruct!.msg
    let payload = resultStruct!.payload
        
    if code == 0 {
       print("获取行为采集结果成功，payload:\(String(cString: payload!))")
     } else {
       print("获取行为采集结果失败，code:\(code),msg:\(String(cString: msg!))")
     }
    ...
    // 离开业务界面时，调用 stop方法，结束行为采集，例如离开登录界面时
    manager?.pointee.stop();

4.code 返回码

错误码	描述	处理方案
0	成功	无需处理
100	没有调用 initWithOptions	没有调用 initWithOptions，需要调用 initWithOptions
101	网络鉴权结果还没有返回	向用户抛出错误：“网络原因，请检查网络后重试”，引导用户重新调用 collect 方法
102	系统原因导致的鉴权接口网络错误，例如没有网络连接等	向用户抛出错误：“网络原因，请检查网络后重试”，引导用户重新调用 collect 方法
103	鉴权接口后端返回状态码非200	检查 partner、appKey、country 这三个参数是否填写正确，如果还是失败，提供错误信息resultStruct.msg给我司运营确认参数是否正确且在有效期内
104	SDK内部容器中没有数据	确保调用collect方法前调用了start方法；调用collect方法后，会清空 SDK内部容器中数据，如果再次立即调用 collect 方法，如果这时没来及采集到行为数据到SDK内部容器中，会导致这个错误；