设备风险 SDK iOS 接入

初始化 SDK 采集数据

SDK 内部初始化与数据采集，务必确保用户同意《风险识别 SDK 隐私权政策》之后，在风险场景尽早通过阿里云设备风险识别 SDK 采集数据。

• 函数原型

@interface SecurityDevice : NSObject
/**
 *  设备指纹初始化函数
 */
- (void)initDevice:(NSString *)userAppKey :(void (^)(int))initCallback;

/**
 * 带参数的初始化
 */
- (void)initDevice:(NSString *)userAppKey withOptions:(NSMutableDictionary *)options callback:(void (^)(int))initCallback;

@end

• userAppKey：用于标识用户身份，阿里云分配的产品 AppKey（不同于 AK），可在阿里云控制台的设备 App 管理申请获取。

• options：信息采集可选项，默认可以为 nil。可选参数如下：

• initCallback：初始化回调监听接口，可在回调中判断初始化是否成功，默认可以为 nil。其中，code 字段取值范围参考"状态返回值"。

• 返回值：无。

• 调用示例

NSMutableDictionary *options = [[NSMutableDictionary alloc] init];
[options setValue:@"0" forKey:@"IPv6"];       // 设置 IPv4
// 设置自定义的数据上报地域
// [options setValue:@"xxx" forKey:@"CustomUrl"];  设置上报站点 Url
// [options setValue:@"xxx" forKey:@"CustomHost"]; 设置上报站点 Host

// 标准调用(推荐)
[[SecurityDevice sharedInstance] initDevice:@"******" withOptions:options callback:nil];

// 回调调用
[[SecurityDevice sharedInstance] initDevice:@"******" withOptions:options callback:^(int code) {
    NSString * initResult = [NSString stringWithFormat: @"初始化结果 %d", code];
    NSLog(@"%@", initResult);

    if (SC_SUCCESS != code) {
        NSLog(@"初始化失败");
    } else {
        NSLog(@"初始化成功");
    }
}];

获取客户端 Token

获取客户端 Token，并上报到业务服务器，后续通过服务器端设备风险识别 API 获取设备风险信息。

• 函数原型

@interface SecurityDevice : NSObject
- (SecurityToken *)getDeviceToken;
- (SecurityToken *)getDeviceToken:(NSString *)bizId;
@end

• bizId：客户的业务 ID，可用于关联业务 ID 和 token。默认情况可以不传。

• 返回值：SecurityToken 类型，定义如下：

@interface SecurityToken : NSObject

/**
 * 获取 Session 操作的结果
 */
@property(atomic) int code;

/**
 * 包含 token 结果的字符串
 */
@property(copy, atomic) NSString *token;

@end

• code：返回接口调用状态码，可用于判断接口调用是否成功。code 返回值：

  FaceSecCode	Code	备注
  SC_SUCCESS	10000	SDK 初始化成功。
  SC_NOT_INIT	10001	SDK 未初始化。
  SC_NOT_PERMISSION	10002	SDK 需要的基础权限未完全授权。
  SC_UNKNOWN_ERROR	10003	系统未知错误。
  SC_NETWORK_ERROR	10004	网络错误。
  SC_NETWORK_ERROR_EMPTY	10005	网络错误，返回内容为空串。
  SC_NETWORK_ERROR_INVALID	10006	网络返回的格式非法。
  SC_PARSE_SRV_CFG_ERROR	10007	服务端配置解析失败。
  SC_NETWORK_RET_CODE_ERROR	10008	网关返回失败。
  SC_APPKEY_EMPTY	10009	AppKey 为空。
  SC_PARAMS_ERROR	10010	其他参数错误。
  SC_FGKEY_ERROR	10011	密钥计算错误。
  SC_APPKEY_ERROR	10012	APPKey 无效。

• token：返回客户端 token 字符串信息，可用于业务后续查询阿里云设备风险识别接口。

• 调用示例

// 推荐传入 bizId,防止 deviceToken 被篡改
NSString *bizId = @"1234567890abcdef******";
SecurityToken *deviceToken = [[SecurityDevice sharedInstance] getDeviceToken:bizId];

if (deviceToken == nil || SC_SUCCESS != deviceToken.code) {
    NSLog(@"获取 token 失败, 调用结果不可用于风险标签查询");
} else {
    NSLog(@"获取 token 成功, 后续可以正常查询风险标签. Token: %@", deviceToken.token);
}

携带 Token 请求服务端

成功获取 deviceToken 后，可携带此参数请求业务服务器，由服务端查询并校验结果。