# SmAntiFraud **Repository Path**: commind-vender/SmAntiFraud ## Basic Information - **Project Name**: SmAntiFraud - **Description**: SmAntiFraud - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-04-08 - **Last Updated**: 2025-04-08 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README 数美设备指纹 SDK（即 'smsdk'）最低支持 iOS 9。 ## 1 工程配置[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#1-工程配置) ### 1.1 导入 smsdk 包[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#11-导入-smsdk-包) 新版 smsdk 使用 .xcframework 形式的包，导入方式如下： 1. 复制 SmAntiFraud.xcframework 到项目中 2. 使用 Xcode 打开项目，点击项目，点击对应的 target，选择 General 页面。 3. 在 Frameworks,Libraries,and Embedded Content 中，点击 + 号 -> Add Other -> Add Files -> 选择 SmAntiFraud.xcframework，Embed方式选择 `Do Not Embeded`。 4. 导入 smsdk 包后，代码中通过 `#import` 导入引用： \#import Copy ### 1.2 添加 smsdk 依赖[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#12-添加-smsdk-依赖) 在 TARGETS -> General -> Frameworks,Libraries,and Embedded Content 中导入如下依赖库 - `IOKit.framework` ### 1.3 http 设置[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#13-http-设置) smsdk 默认使用 http 请求，根据苹果的 ATS 标准，需要配置 Info.plist： 1. 点击项目的 Info.plist，点击 + 号，选中 App Transport Security Settings 2. 在 App Transport Security Settings 配置项中，点击 + 号，选择 Allow Arbitrary Loads，并配置为 YES ### 1.4 idfa 配置[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#14-idfa-配置) 如果 APP 之前未采集过 `IDFA` ，上架App Store时，需要根据App Connect的政策，明确app中使用`idfa`并说明原因，若不想使用 `IDFA`，可参考下面启动SDK章节，设置 `notCollect` 不采集 `IDFA`，若app归属于儿童类，则联系数美运营提供不包含采集 `IDFA` 相关代码的SDK。 ### 1.5 配置隐私文件[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#15-配置隐私文件) 根据[苹果隐私政策规定](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files?language=objc)，嵌入数美SDK的app需要在Xcode项目的 PrivacyInfo.xcprivacy 中补全条款，若项目中没有，需要根据[官方说明](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files?language=objc)使用Xcode 15及以上的版本新建一个 PrivacyInfo.xcprivacy 文件。参考以下两种方式中的任意一种，添加数美SDK依赖的隐私条款： - 以默认的 Property List 配置 1. 在 Xcode 中选择 PrivacyInfo.xcprivacy 2. 将以下条款添加到 PrivacyInfo.xcprivacy 中的`Privacy Nutrition Label Types`和`Privacy Accessed API Types`下，具体配置如下图： ![privacy](https://help.ishumei.com/assets/images/privacy-d94b2a7e5f4b94e1877f46f7974a7c16.png) - 以 Source Code 配置 1. 在 Xcode 中右键 PrivacyInfo.xcprivacy，选择 Open As，选择 Source Code。 2. 添加 NSPrivacyCollectedDataTypes 相关条款：将以下文本粘贴到最外层的``和``中的key值为`NSPrivacyCollectedDataTypes`下，若无此key值，则需要先创建。 NSPrivacyCollectedDataTypes NSPrivacyCollectedDataType NSPrivacyCollectedDataTypeDeviceID NSPrivacyCollectedDataTypeLinked NSPrivacyCollectedDataTypeTracking NSPrivacyCollectedDataTypePurposes NSPrivacyCollectedDataTypePurposeAppFunctionality NSPrivacyCollectedDataType NSPrivacyCollectedDataTypeFitness NSPrivacyCollectedDataTypeLinked NSPrivacyCollectedDataTypeTracking NSPrivacyCollectedDataTypePurposes NSPrivacyCollectedDataTypePurposeAppFunctionality Copy 3. 添加 NSPrivacyAccessedAPITypes 相关条款：将以下文本粘贴到最外层的``和``中的key值为`NSPrivacyAccessedAPITypes`下，若无此key值，则需要先创建。 NSPrivacyAccessedAPITypes NSPrivacyAccessedAPITypeReasons 35F9.1 NSPrivacyAccessedAPIType NSPrivacyAccessedAPICategorySystemBootTime NSPrivacyAccessedAPITypeReasons C617.1 NSPrivacyAccessedAPIType NSPrivacyAccessedAPICategoryFileTimestamp NSPrivacyAccessedAPITypeReasons CA92.1 NSPrivacyAccessedAPIType NSPrivacyAccessedAPICategoryUserDefaults Copy ## 2 标准接入[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#2-标准接入) ### 2.1 启动SDK[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#21-启动sdk) smsdk 是数美风控体系中的终端，主要功能包括采集设备信息和生成设备标识。当产品需要对相关业务进行风控分析时，可以通过 `SmAntiFraud` 类的 `create` 方法进行风控。**注意**调用 `create` 方法会立即采集设备信息，所以 **必须** 在同意隐私政策后且需要风控的场景下调用 `create` 方法，避免引起非合理场景采集不必要信息问题。调用 `-[SmAntiFraud create:]` 方法启动SDK。启动SDK非阻塞当前线程，会采集数据并网络传输，缓存 `deviceId`，调用时机如下 1. APP 首次启动，同意隐私政策后调用。 2. APP 非首次启动，且同意了隐私政策，启动时调用。若`create`方法返回`NO`，则需要检查启动SDK参数是否正确，可以过滤日志中的 `Smlog` 进行自检。启动SDK需要 `SmOption` 实例，其中的具体参数如下 | **字段** | **参数类型** | **是否必填** | **默认值** | **字段说明** | | ----------------- | ------------------------ | ------------ | ----------------------------------------------- | ------------------------------------------------------------ | | organization | NSString* | 是 | null | 数美分配的公司标识，数美后台可以查看 | | appId | NSString* | 是 | null | 应用标识，区分不同应用，数美后台可以查看 | | publicKey | NSString* | 是 | null | 公钥标识，开通账号发送邮件中publicKey项 | | url | NSString* | 否 | http://fp-it.fengkongcloud.com/deviceprofile/v4 | 设备数据上传的url | | confUrl | NSString* | 否 | http://fp-it.fengkongcloud.com/v3/cloudconf | 请求云配的url | | extraInfo | NSString* | 否 | null | 额外信息 | | cloudConf | BOOL | 否 | YES | 是否开启云配功能，YES代表开启 | | transport | BOOL | 否 | YES | 是否开启设备指纹功能，YES代表开启 | | usingShortBoxData | BOOL | 否 | NO | 是否使用较短的boxData，NO代表不使用 | | delegate | `id` | 否 | null | 使用回调方法异步获取标识时，实现`ServerSmidProtocol`的对象 | | notCollect | NSArray | 否 | null | 设置SDK不采集项，目前仅支持"idfa" | | area | SmAntiFraudArea | 否 | AREA_BJ | 数据上传和云配的服务器机房地址。 AREA_BJ：北京机房 AREA_XJP：新加坡机房 AREA_FJNY：弗吉尼亚机房 | | useHttps | BOOL | 否 | NO | 是否使用 https 协议网络请求 | ### 2.2 获取标识[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#22-获取标识) 客户端获取到标识分为 `boxId` 和 `boxData`，**两者都会变化**。若需要唯一不变的标识，查看 ”解密工具及代理服务器说明设备指纹标识解密“ 章节，了解如何获取明文设备标识。 - 同步方式调用 `-[SmAntiFraud getDeviceId]` 方法获取设备标识，调用时机如下 1. 调用`create` 方法启动SDK返回 `YES` 后 1～2 秒。时间供SDK收集数据和网络传输。 2. 在业务事件时使用，比如登录、注册等关键事件中上报 `getDeviceId` 返回的字符串。 - 异步方式异步方式可以在启动SDK之后，最早时机获取到服务端下发的最新的boxId。需要调用`-[SmOption setDelegate:]`设置实现了 `ServerSmidProtocol` 接口的实例对象，具体方式如下 1. 继承 `ServerSmidProtocol` 接口，如 `@interface ViewController () ` 2. 实现接口的 `smOnSuccess` 和 `smOnError` 方法，如 \- (void)smOnSuccess:(NSString*) boxId { // 服务器下发成功或缓存中有可用 boxId } \- (void)smOnError:(NSInteger) errCode { // 服务端下发标识失败，错误码：errCode // 尝试使用 `-[SmAntiFraud getDeviceId]` 方法主动获取标识 // 数美未对errCode进行任何处理，需业务方自行记录，处理分析等 } Copy 3. 在 `SmOption` 对象中设置 `delegate`，如 `[option setDelegate:self]` `errCode`错误码列举如下 | errCode | **描述** | | ------- | ------------------------------------------------------------ | | -1 | 无网络，常见原因：设备无网络 | | -2 | 网络异常，网络连接异常或者 http 状态非 200，常见原因：代理或私有化服务器配置错误 | | -3 | 业务异常，下发业务状态码非 1100，服务器未返回 deviceId，常见原因：参数配置错误、qps 超限、服务器异常 | | -4 | 未知错误 | ### 2.3 代码示例[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#23-代码示例) // 启动SDK参数对象 SmOption *option = [[SmOption alloc] init]; [option setOrganization: @"YOUR_ORGANIZATION"];// 必填 [option setAppId:@"YOUR_APP_ID"]; // 必填 [option setPublicKey:@"YOUR_PUBLICK_KEY"]; // 必填 // 启动SDK BOOL isOk = [[SmAntiFraud shareInstance] create:option]; if (!isOk) { // 检查option启动SDK参数是否设置正确 } Copy ### 2.4 接入检验[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#24-接入检验) 参考 "测试" 章节自查是否接入SDK成功。 ## 3 海外业务接入[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#3-海外业务接入) 海外业务需按代理模式接入，若无法提供代理服务，可以使用数美的海外的服务器节点，主要步骤与标准接入相同，需要增加以下配置 1. 业务机房在欧美（弗吉尼亚机房） // 用户分布范围为欧美 [option setArea:AREA_FJNY]; // 用户分布范围为全球，则需要开启加速功能，配置如下 // [option setArea:AREA_FJNY]; // NSString* host = @"http://fp-na-it-acc.fengkongcloud.com"; // [option setUrl:[host stringByAppendingString:@"/deviceprofile/v4"]]; // [option setConfUrl:[host stringByAppendingString:@"/v3/cloudconf"]]; Copy 2. 业务机房在欧美（法兰克福机房） NSString* host = @"http://api-device-eur.fengkongcloud.com"; [option setUrl:[host stringByAppendingString:@"/deviceprofile/v4"]]; [option setConfUrl:[host stringByAppendingString:@"/v3/cloudconf"]]; Copy 3. 业务机房在东南亚（新加坡机房） *// 用户分布范围为东南亚* [option setArea:AREA_XJP]; *// 用户分布范围为全球，则需要开启加速功能，配置如下* *// [option setArea:AREA_XJP];* *// NSString\* host = @"http://fp-sa-it-acc.fengkongcloud.com";* *// [option setUrl:[host stringByAppendingString:@"/deviceprofile/v4"]];* *// [option setConfUrl:[host stringByAppendingString:@"/v3/cloudconf"]];* Copy ## 4 私有化接入[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#4-私有化接入) 主要步骤与标准接入类似，需要增加以下配置 // 设置私有地址，将 private-host 替换为私有化的主机名（域名） NSString *host = @"http://private-host"; [option setUrl: [host stringByAppendingString:@"/deviceprofile/v4"]]; // 示例路径，需要与真实场景一致 [option setConfUrl:[host stringByAppendingString:@"/v3/cloudconf"]]; // 示例路径，需要与真实场景一致 Copy 注意，如果传入 host 为 http 请求，如 `http://private-host`，需要确保 APP 可以发送 http 请求，参考 "工程配置" 章节 http 设置部分。私有化接入完成后，需要根据 "测试" 章节进行自测检查。 ## 5 代理接入[#](https://help.ishumei.com/docs/tw/sdk/iOS/developDoc#5-代理接入) 主要步骤与标准接入类似，需要增加以下配置 *// 设置私有地址，将 host 替换为代理服务器的主机名（域名）* String host = "https://proxy-host"; [option setUrl: [host stringByAppendingString:@"/deviceprofile/v4"]]; *// 示例路径，需要与真实场景一致* [option setConfUrl:[host stringByAppendingString:@"/v3/cloudconf"]]; *// 示例路径，需要与真实场景一致* Copy 开发者需要自行搭建代理服务器，代理服务器相关处理参考 “代理服务器说明代理接入“ 章节。