1. 根据应用/游戏开发平台，将SDK拷贝到指定的工程目录，并修改项目配置；
2. 接入风控SDK必接接口，根据业务需求接入建议接口；
3. 测试风控SDK接入是否正确；
4. 验证风控SDK功能效果；
5. 按业务常规发版流程进行测试与发版
全局必须要接入的接口：初始化接口
用户登录后必须要接入的接口：设置用户信息接口
关键业务埋点时必须要使用的接口：同步获取凭证/异步获取凭证
强烈建议接入的接口：交互接口
建议接入的接口：心跳接口、安全通信协议接口
三、接入步骤
请登录易盾官网后台风控引擎-服务管理获取SDK，详情如图
将插件文件夹粘贴到工程目录中（以htprotect_example为例）。 在项目根目录建立 plugins（可自定）文件夹，将plugin项目移至其中，移动后目录架构如下
打开项目的pubspec.yaml，在dev_dependencies中添加易盾 plugin 插件
更新依赖，在Flutter项目根目录下执行：Flutter pub get
若使用ProGuard进行混淆，需要将SDK使用的类排除掉。若使用Android Studio开发，则在proguard-rules.pro文件中添加如下信息：
-keep class com.netease.htprotect.**{*;}
-keep class com.netease.mobsec.**{*;}
### <a id="3.2">**SDK接口调用**</a>
（1）初始化
import 'package:htprotect/htprotect.dart';
初始化接口
_htprotectPlugin.init("易盾产品编号", params: params).then((initResult) {
var code = initResult['code'];
if (code == kHTPInitSuccessCode) {
Fluttertoast.showToast(
msg: "Init successfully", gravity: ToastGravity.CENTER);
} else {
String Msg = initResult['Msg'];
Fluttertoast.showToast(
msg: 'init failed, Msg is: $Msg',
gravity: ToastGravity.CENTER);
部分产品相关参数请用账号登录易盾官网控制台获取参考
（2）登录接口
用户登录或者切换游戏账号的时候，调用以下接口
String businessId = "易盾提供的业务id";
String roleId = "testroleId";
String roleName = "testroleName";
String roleAccount = "testroleAccount";
String roleServer = "testroleServer";
int serverId = 123;
String gameJson = "{'gameVersion': 'ccc', 'assetVersion': 'ddd'}";
_htprotectPlugin.setRoleInfo(businessId, roleId, roleName, roleAccount, roleServer, serverId, gameJson).then((result) {
1、确认客户端SDK相关接口已调用
2、运行程序，确保已触发相关接口。
3、前往官网查询数据；输入角色信息进行查询。
SDK 接入调用说明
接口用途：
用于初始化智能风控 SDK。
接入须知：
使用其他接口之前，必须先调用初始化接口，建议在应用/游戏启动过后第一时间调用（初始化后，并不会获取任何个人隐私相关信息）；
该接口为 必须调用接口。
函数原型：
Future<Map<dynamic, dynamic>> init(String productId,{Map<String, dynamic>? params})
参数说明：
入参说明：
params.serverType
设置服务器归属地 ,智能风控默认上报的服务器为中国大陆的服务器，若需要更改服务器归属地，可以调用该接口进行配置，支持的类型如下：
serverType = 1 中国大陆地区，默认为该值，无需设置
serverType = 2 中国台湾地区
serverType = 3 海外地区
channel
设置渠道信息，供用户传入该app的渠道信息（比如：App Store CN/App Store EU）
extData
设置额外信息，在数据上报中包含的额外信息
params['serverType'] = 1;
params['channel'] = 'test';
params['gameKey'] = '8ef016947a1eeed4ac5b07c700e2b3f5';
var map1 = {'aa': 'aaa', 'bb': 'bbb'};
params['extData'] = map1;
_htprotectPlugin.init(productId, params: params).then((initResult) {
var code = initResult['code'];
if (code == 200) {
Fluttertoast.showToast(
msg: "Init successfully", gravity: ToastGravity.CENTER);
} else {
String Msg = initResult['Msg'];
Fluttertoast.showToast(
msg: 'init failed, Msg is: $Msg',
gravity: ToastGravity.CENTER);
接口用途：
游戏类型应用，在进行数据采集的过程中，会将角色 ID，角色名称、用户/角色账号等设置在风控 SDK 采集的数据中一同上传，用于表示角色信息，以便对有恶意、风险行为的用户/角色进行相应的处置。
接口须知：
须在 SDK 初始化且 用户同意隐私政策后才能调用该接口；
凡事涉及到用户登录、或者切换角色的地方，均需要调用该接口设置或者更新用户/玩家信息；
函数原型：
Future<int> setRoleInfo(
String businessId,
String roleId,
String roleName,
String roleAccount,
String roleServer,
int serverId,
String gameJson)
参数说明：
示例代码：
Future<void> setRoleInfo() async {
String businessId = "31c9823e57b3b789341db4812c562ef1";
String roleId = "testroleId";
String roleName = "testroleName";
String roleAccount = "testroleAccount";
String roleServer = "testroleServer";
int serverId = 123;
String gameJson = "{'gameVersion': 'ccc', 'assetVersion': 'ddd'}";
_htprotectPlugin.setRoleInfo(businessId, roleId, roleName, roleAccount, roleServer, serverId, gameJson).then((result) {
函数返回：
函数返回 int 类型，可能出现的值如下：
须在 SDK 初始化接口被调用后方可调用，在用户/玩家退出当前角色（包括切换角色）或者退出游戏时调用接口。
此接口主要用于判断用户/玩家本次生命周期，不强制要求接入。
如果未调用初始化，此接口默认为空，不会执行任何逻辑。
函数原型：
- (void)logOut;
示例代码：
Future<void> logOut()
接口用途：
用于关键业务节点风险防控场景中，比如注册、登录、领劵、抽卡、兑换、点赞、评论等业务场景。业务方可通过此接口，获取检测唯一凭证 token。业务服务端通过此凭证实时获取当前用户/玩家风险检测结果，并根据结果进行处置。
接口适用场景为:
1、游戏类应用，当 SDK 数据上报接口被屏蔽导致数据上报失败时，通过 getToken 接口获取 SDK 采集信息，并由客户服务端传递给易盾服务器；
2、全类型应用，在关键业务节点主动调用检测时，通过 getToken 接口获取检测凭证，由客户服务端通过 token 凭证从易盾服务器查询检测结果。
接入须知：
须在 SDK 初始化且用户同意隐私政策后才能调用该接口，网易易盾隐私说明。
内部存在网络请求，只允许在子线程上调用。
函数原型：
Future<Map<dynamic, dynamic>> getToken(int timeout, String businessId)
参数说明：
入参说明：
_htprotectPlugin.getToken(3000,"易盾业务id").then((result) {
var code = result['code'];
String token = result['token'];
Fluttertoast.showToast(
msg: 'code is $code, token is: $token',
gravity: ToastGravity.CENTER);
接口用途：
用于在客户端查询 SDK 采集的基础数据、设置需要传递给 SDK 数据（比如初始化配置内容、check 结果信息等）、及其他可能的定制功能服务。
接入须知：
接口调用前置条件是：调用了初始化接口并且同意隐私政策之后。
函数原型：
Future<String> ioctl(int request, String data)
参数说明：
Android：
入参说明：
request
1 ：模拟器名称签名信息
2 ：是否root
3 ：本地随机生成的设备ID
7 ：SDK版本
9 ：加密后的当前SDK版本
14： SDK运行状态，应对线程被挂起或其他导致无法运行时但是接口正常使用的状态
16 ：初始化配置内容，防止初始化失败情况下，客户可以通过服务端请求初始化配置并传递给SDK
17 ：客户服务端将check结果传递给SDK，便于执行后续动作
设置信息的附加数据
可选，不需要可填null
result
String
入参 request = 1 ,result : 返回模拟器名称，示例：emulator：Nox；若为未知模拟器，则返回：emulator：Unknown；若为真机，则返回：emulator：None
入参 request = 2, result: 当前设备是否root信息。若为root设备，返回值为：root：1；若不是root设备，返回值为：root：0
入参 request = 3, result: 当前设备id，比如“c09cb89662e6719f956f23651be42006”
入参 request = 7, result: 风控 SDK 版本号一定不为空，返回值示例：“5.3.5”
入参 request = 9, result: 风控 SDK 版本号一定不为空，返回值示例：“iF13uXaKVteXVA==||58807f98da0d945b5d60ba4e8f22a428"，解密方式请联系易盾技术支持
入参 request = 14, result: 返回值为字符串格式： -1：SDK未启动 0：运行正常 大于0：运行异常
入参 request = 16, result: {"s":0,"v":33554433}
//s：状态，int类型，只有为0，v 字段的值才有意义;
// v：版本，long类型(8字节)，配置的版本
入参 request = 17, result:返回值为字符串格式： 0或者-1,输入数据格式有误;1为解析成功
request
对应向风控系统请求的命令：0 ：签名信息
2 ：越狱状态
7 ：SDK版本
16 ：初始化配置内容，防止初始化失败情况下，客户可以通过服务端请求初始化配置并传递给SDK
17： 客户服务端将check结果传递给SDK，便于执行后续动作
99 ：32位deviceID
100 ：64位deviceID
设置信息的附加数据
可选，不需要可填null
result
String
入参 request = 0 ,result : 返回当前应用的签名信息，便于区分是盗版应用还是正版应用
入参 request = 2, result: 当前设备是否越狱信息。若为越狱设备，返回值为：1；若不是越狱设备，返回值为：0
入参 request = 7, result: 风控 SDK 版本号一定不为空，返回值示例：“2.0.1”
入参 request = 16, result: 返回值为字符串格式： 0或者-1输入数据格式有误,1解析成功
入参 request = 16, result: 向风控 SDK 配置传递从易盾服务端获取到的命中及响应结果信息，以便 SDK 执行相关处置动作 返回值为字符串格式： 0或者-1输入数据格式有误,1解析成功
接口用途：
为保障风控 SDK 服务的安全运行，防止易盾风控服务被中止或者被剥离，定时向应用/游戏方客户端反馈风控 SDK 的心跳信息，告知应用/游戏方当前风控 SDK 运行状态，既方便应用/游戏方实时掌握风控服务运行状态，也能保证易盾风控服务正常运行。
同时心跳接口也可以主动实时返回风控数据（有别于交互接口），如需要详细说明文档，请联系易盾获取。
接口须知：
须在 SDK 初始化且用户同意隐私政策后才能调用该接口；
心跳系统在非主线程中运行，如需进行UI操作请切回到主线程中。
函数原型：
void registInfoReceiver()
Future<void> _onCallBack(Map info) async {
// 心跳回调信息
// String type = message['type'];
// String info = message['info'];
Fluttertoast.showToast(
msg: '_onInitCallBack: $info', gravity: ToastGravity.CENTER);
参数说明：
回调参数说明：
seq、t和net是否出现，该三个标识为心跳系统一定会返回的值，若无，说明反外挂异常；
seq的值是否符合"从1开始依次递增"的规则，若不符合，说明返回值被篡改；
net为0是否长期出现，若5分钟内net的取值都为0，说明网络异常；
若出现反外挂异常或网络异常，请结合游戏业务数据综合判断并自行处理。
接口用途：
应用/游戏协议如被破解，若为单机游戏类型应用，可直接影响到存档文件的安全性；若为帧同步游戏类型应用，可通过破解协议修改战斗数据；若为其他游戏类型应用，可被做成脱机协议，用于攻击或制作脱机外挂；若为非游戏类型应用，则可伪造业务数据欺骗客户端应用。为了保障应用/游戏协议安全，易盾风控服务提供 “数据校验” 方案，采用自研通讯协议校验算法。
接口须知：
客户端接入数据校验接口后，客户服务端需要对对应的数据进行校验，数据校验相关说明文档请联系易盾获取；
对于与服务端有通信的应用/游戏，强烈建议 使用该接口进行数据校验。
函数原型：
Future<String> getDataSign(String inputData, int algIndex)
参数说明：
返回的数据即为校验结果，开发者需要将原始数据与校验结果发送到应用/游戏服务端，由应用/游戏服务端校验。
示例代码：
_htprotectPlugin.getDataSign(inputData,algIndex).then((result) {
Fluttertoast.showToast(
msg: 'result is: $result',
gravity: ToastGravity.CENTER);
服务端数据签名计算代码
服务端代码:
function getDataSign($data,$appkey)
校验函数使用示例:
$inputdata = "sfsfsfdsfsdfssdssdsdf";
$appkey = 客户的appid;
$sign = getDataSign($inputdata,$appkey);
这里计算生成的$sign 应该跟客户端返回的 sign 值一致
接口用途：
该接口用于对通信数据进行白盒加密和白盒 HMAC 签名（相当于 数据校验接口 的升级版本），加密和签名的密钥均会被隐藏，攻击者无法获取，从而保障应用/游戏的通信安全。
最新版本接口（V2.1）更新内容如下：
自定义二进制格式，增大分析难度；
多重加密，防明文传输；
数据将进行校验，防止篡改；
支持多算法，一旦加密算法被破解，可及时更新为另一种算法；
一次一密，每次加密的密钥都不相同；
自定义安全随机数发生器，防止系统随机数接口被篡改，始终生成一样的密钥；
防重放攻击；
防模拟执行(脱离Android/iOS环境运行)。
接口须知：
1、如需使用该接口，请联系易盾获取详细说明文档。
（1）加密数据到服务端
Future<void> safeCommToServer(int version, int alg, String input, bool isCrucial);
入参说明：
示例代码：
_htprotectPlugin.safeCommToServer(version,alg,input,isCrucial).then((result) {
Fluttertoast.showToast(
msg: 'result is: $result',
gravity: ToastGravity.CENTER);
（2）解密服务端的数据
Future<Map<dynamic, dynamic>> safeCommFromServer(int alg, int timeout, String input)
入参说明：
示例代码：
_htprotectPlugin.safeCommFromServer(alg,timeout,input).then((result) {
Fluttertoast.showToast(
msg: 'result is: $result',
gravity: ToastGravity.CENTER);
上一篇：C++_Windows
下一篇：uniapp接入
