集成要求

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

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

1.2 为向贵司提供业务安全和风控服务，小盾 SDK 将采集、处理、使用用户的手机终端唯一标志信息IDFA、Android ID、OAID(包含VAID、AAID)、MAC 地址、WIFI列表、无线路由器标识（BSSID、SSID）、设备类型、设备型号、系统类型、粗略位置信息、精准位置信息、应用程序列表、运行中进程信息、网络制式、设备软件版本号、传感器（光传感器、重力传感器、磁场传感器、加速度传感器、陀螺仪传感器、心率传感器）相关设备信息。为确保贵司使用相关服务的合规性，前述隐私政策应涵盖对小盾SDK提供服务并采集、处理、使用相关信息的授权，以上内容供贵司参考，具体表述可由贵司根据贵司隐私协议的整体框架和内容自行确定。

个人信息类处理规则(隐私政策)：https://xiaodun.com/other/privacy/id=4
使用说明：合规使用指导

环境要求

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

安装(CocoaPods)

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

初始化

注意事项

确保在用户同意隐私协议后，再进行SDK初始化。

引入头文件

在调用的位置引入头文件

#import <TDMobRisk/TDMobRisk.h>

import TDMobRisk

方法定义

void (*initWithOptions)(NSDictionary *options);

获取设备信息

注意事项

请在 initWithOptions后调用getDeviceInfo

方法定义

void (*getDeviceInfo)(TDDeviceInfoCallback callback);

最佳实践

在应用程序入口处初始化

- (void)initDeviceManagerSDK {
  TDDeviceManager_t *manager = [TDDeviceManager sharedManager];
  NSMutableDictionary *options = [NSMutableDictionary dictionary];
  
  /*************************** 必传 ***************************/
  // 合作方编码(partnerCode)，参考下方全部配置说明
  [options setValue:@"请输入您的partnerCode" forKey:@"partner"];
  // 平台注册的应用标识，参考下方全部配置说明
  [options setValue:@"请输入您的appKey" forKey:@"appKey"];
  // 数据中心地区参数，参考下方全部配置说明`
  [options setValue:@"请输入您所在的国家地区" forKey:@"country"];

  manager->initWithOptions(options);
}

func initDeviceManagerSDK() {
  let manager = TDDeviceManager.sharedManager()
  var options = Dictionary<String, Any>()
  /*************************** 必传 ***************************/
  // 合作方编码(partnerCode)，参考下方全部配置说明
  options.updateValue("请输入您的partnerCode", forKey: "partner")
  // 平台注册的应用标识，参考下方全部配置说明
  options.updateValue("请输入您的appKey", forKey: "appKey")
  // 数据中心地区参数，参考下方全部配置说明
  options.updateValue("请输入您所在的国家地区", forKey: "country")

  manager.pointee.initWithOptions(options)
}

在实际业务节点获取设备信息

    TDDeviceManager_t *manager = [TDDeviceManager sharedManager];
    manager->getDeviceInfo(^(TDDeviceResponse response){
        int code = response.apiStatus.code;
        // ❗️Attention❗️局部char类型字符串在多线程情况下必须按以下方式先转换成NSString类型，再使用NSString变量进行多线程传递，返回的c字符串在线程切换时可能会被释放
        if(code == 0) {// 成功
            NSString* fpVersion = @(response.fpVersion);
            NSString* blackBox = @(response.blackBox);
            NSString* anonymousId = @(response.anonymousId);
            NSString* message = @(response.apiStatus.message);
            NSString* sealedResult = @(response.sealedResult);
            int deviceRiskScore = response.deviceRiskScore;
        }
        else{// 失败
            NSString* message = @(response.apiStatus.message);
        }
      // ❗️Attention❗️使用上述声明的变量进行多线程传递
    });

    let manager = TDDeviceManager.sharedManager()
    manager.pointee.getDeviceInfo() { (response: TDDeviceResponse!)->Void in
         let code = response.apiStatus.code
         // ❗️Attention❗️局部char类型字符串在多线程情况下必须按以下方式先转换成String类型，再使用String变量进行多线程传递，返回的c字符串在线程切换时可能会被释放
         if code == 0 {// 成功
             let fpVersion = String(validatingCString: response.fpVersion)
             let blackBox = String(validatingCString: response.blackBox)
             let anonymousId = String(validatingCString: response.anonymousId)
             let message = String(validatingCString: response.apiStatus.message)
             let sealedResult = String(validatingCString: response.sealedResult)
             let deviceRiskScore = response.deviceRiskScore
         }
         else {// 失败
             let message = response.apiStatus.message
         }
      	// ❗️Attention❗️使用上述声明的变量进行多线程传递
     }

状态检查

当getDeviceInfo() 回调的 code == 0 时即代表获取设备信息成功；

响应结果

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

字段	描述
anonymousId	设备匿名ID，设备标识
blackBox	调用日志查询标识
fpVersion	SDK版本号
deviceRiskScore	当前设备风险分
sealedResult	加密的设备信息，二进制 Base64 编码字符串，仅在客户端密封结果开启时返回

其他说明

获取SDK版本号

TDDeviceManager_t *manager = [TDDeviceManager sharedManager];
NSString *sdkVersion = manager->getSDKVersion();

let manager = TDDeviceManager.sharedManager()
let sdkVersion = manager.pointee.getSDKVersion()

全部配置

配置Key	说明	示例代码	移除字段
partner(必须)	合作方编码，请联系我司运营或者从客户平台获取	Objective C `[options setValue:@"请输入您的合作方编码" forKey:@"partner"];` Swift `options.updateValue("请输入您的合作方编码" , forKey: "partner")`
appKey(必须)	应用标识，通过客户平台创建，参考如何申请appKey	Objective C `[options setValue:@"请输入您的appKey" forKey:@"appKey"];` Swift `options.updateValue("请输入您的appKey" , forKey: "appKey")`
country(必须)	数据中心地区： cn代表中国 us代表美国 sg代表新加坡 fra代表德国 idna代表印尼	Objective C `[options setValue:@"cn" forKey:@"country"];` Swift `options.updateValue("cn" , forKey: "country")`
channel	渠道标识，请联系运营获取	Objective C `[options setValue:@"请输入您的channel" forKey:@"channel"];` Swift `options.updateValue("请输入您的channel", forKey: "channel")`
timeLimit	网络请求回调的超时时间，单位秒，默认为15s	Objective C `[options setValue:@(5) forKey:@"timeLimit"];` Swift `options.updateValue(5, forKey: "timeLimit")`
location	是否采集地理位置信息，默认开启	Objective C `[options setValue:@(NO) forKey:@"location"];` Swift `options.updateValue(false, forKey: "location")`	latitude、longitude、gps_location
IDFA	是否采集广告标识符，默认开启	Objective C `[options setValue:@(NO) forKey:@"IDFA"];` Swift `options.updateValue(false, forKey: "IDFA")`	idfa
IDFV	是否采集应用开发厂商标识符，默认开启	Objective C `[options setValue:@(NO) forKey:@"IDFV"];` Swift `options.updateValue(false, forKey: "IDFV")`	idfv
wifiIp	是否采集 wifiIp，默认开启	Objective C `[options setValue:@(NO) forKey:@"wifiIp"];` Swift `options.updateValue(false, forKey: "wifiIp")`	wifiIp
cellIp	是否采集 cellIp，默认开启	Objective C `[options setValue:@(NO) forKey:@"cellIp"];` Swift `options.updateValue(false, forKey: "cellIp")`	cellIp
vpnIp	是否采集 vpnIp，默认开启	Objective C `[options setValue:@(NO) forKey:@"vpnIp"];` Swift `options.updateValue(false, forKey: "vpnIp")`	vpnIp
wifiIpv6	是否采集 wifiIpv6，默认开启	Objective C `[options setValue:@(NO) forKey:@"wifiIpv6"];` Swift `options.updateValue(false, forKey: "wifiIpv6")`	wifiIpv6
deviceName	是否采集设备名称，默认开启	Objective C `[options setValue:@(NO) forKey:@"deviceName"];` Swift `options.updateValue(false, forKey: "deviceName")`	device_name
ssid	是否采集ssid信息，默认开启	Objective C `[options setValue:@(NO) forKey:@"ssid"];` Swift `options.updateValue(false, forKey: "ssid")`	ssid
customMessage	自定义消息，sdk支持透传和存储	Objective C `[options setValue:@"this is a customMessage" forKey:@"customMessage"];` Swift `options.updateValue("this is a customMessage", forKey: "customMessage")`

状态码说明

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

typedef struct TDDeviceAPIStatus_Void {
    /// code
    int code;
    /// message
    NSString *message;
    
} TDDeviceAPIStatus;

code和message对应值如下表：

code	message	备注
0	Success.	成功
1000	Access error.	准入发生异常，可能原因：初始化参数无效或网络环境异常
1001	SDK error.	SDK 发生异常，可能原因：未调用初始化函数
1002	Network error.	网络错误
1003	API error.	后端接口返回错误
1004	Traffic limit.	网关限流返回
1005	Traffic shutdown.	流量关停
1100	Unknown error.	未知错误