更新记录

v1.0（2024-04-08）

支持原生易盾风控服务（Android、iOS）

平台兼容性

智能风控 uni-app 接入文档

隐私说明

请参照网易易盾隐私政策，请将易盾隐私政策链接放到应用“用户协议”中。

接入说明

接入“智能风控” SDK，开发者需要完成以下步骤：

1. 根据应用/游戏开发平台，将SDK拷贝到指定的工程目录，并修改项目配置；
2. 接入风控SDK必接接口，根据业务需求接入建议接口；
3. 测试风控SDK接入是否正确；
4. 验证风控SDK功能效果；
5. 按业务常规发版流程进行测试与发版

注意：

• 全局必须要接入的接口：初始化接口
• 用户登录后必须要接入的接口：设置用户信息接口
• 关键业务埋点时必须要使用的接口：同步获取凭证/异步获取凭证
• 强烈建议接入的接口：交互接口

接入步骤

获取核心文件

在将插件放到工程根目录之前，需要登录易盾官网控制台，下载获取Android、iOS风控SDK核心文件，并放到插件包指定文件目录下。 您可联系易盾工作人员，为您提供全程指导。

导入插件

将插件文件夹粘贴到工程根目录的nativeplugins文件夹中。导入插件之后一定要自定义基座方可生效，自定义基座说明请参考 https://uniapp.dcloud.net.cn/tutorial/run/run-app.html#customplayground

SDK接口调用

部分产品相关参数请用账号登录易盾官网控制台获取参考

（1）初始化

插件声明

const htp = uni.requireNativePlugin("htpplugin");

初始化接口

htp.init({
    productId: 'XXXXXXX', // 产品id
    serverType: 1 ,         // 
    channel: 'testchannel', // 渠道名称
}, e => {
    // 回调函数
    uni.showToast({
        title: '响应数据：' + JSON.stringify(e),
        icon: 'none'
    });
})

（2）登录接口

用户登录或者切换游戏账号的时候，调用以下接口

let json = {GameVersion: 'testGameVersion', AssetVersion: 'testAssetVersion'};
let stringJson = JSON.stringify(json);
htp.setRoleInfo({
    businessId: 'xxxxxxxxxxxxxxxxxxxxx',
    roleId: 'testroleId' ,
    roleName: 'testroleName' ,
    roleAccount: 'testroleAccount' ,
    roleServer: 'testroleServer' ,
    serverId: 1 ,
    gameJson: stringJson ,
}, e => {
    // 回调函数
    uni.showToast({
        title: '响应数据：' + JSON.stringify(e),
        icon: 'none'
    });
})

验证SDK接入是否正确

1、确认客户端SDK相关接口已调用

2、运行程序，确保已触发相关接口。

3、前往官网查询数据；输入角色信息进行查询。

SDK 接入调用说明

SDK 初始化接口

接口用途：

用于初始化智能风控 SDK。

接入须知：

1. 使用其他接口之前，必须先调用初始化接口，建议在应用/游戏启动过后第一时间调用（初始化后，并不会获取任何个人隐私相关信息）；
2. 该接口为 必须调用接口。

函数原型：

init( String productId,
      int serverType,
      String channel)

参数说明：

• 入参说明：

  参数	说明	必要性
  productId	易盾HTP分配的productId，可登录易盾后台获取	必填
  serverType	设置服务器归属地 ,智能风控默认上报的服务器为中国大陆的服务器，若需要更改服务器归属地，可以调用该接口进行配置，支持的类型如下： serverType = 1,中国大陆地区，默认为该值，无需设置 serverType = 2, 中国台湾地区 ; serverType = 3 海外地区	可选
  channel	设置渠道信息，供用户传入该app的渠道信息（比如：App Store CN/App Store EU）	可选

• 回调参数说明：

  回调参数	类型	描述
  code	int	初始化结果code码 200:成功 400:插件调用异常
  msg	String	初始化结果详情

示例代码：

htp.init({
    productId: 'XXXXXXX', // 产品id
    serverType: 1 ,         // 服务器归属地
    channel: 'testchannel', // 渠道名称
}, e => {
    // 回调函数
    uni.showToast({
        title: '响应数据：' + JSON.stringify(e),
        icon: 'none'
    });
})

设置用户信息接口

接口用途：

游戏类型应用，在进行数据采集的过程中，会将角色 ID，角色名称、用户/角色账号等设置在风控 SDK 采集的数据中一同上传，用于表示角色信息，以便对有恶意、风险行为的用户/角色进行相应的处置。

接口须知：

1. 须在 SDK 初始化且 用户同意隐私政策后才能调用该接口；
2. 凡事涉及到用户登录、或者切换角色的地方，均需要调用该接口设置或者更新用户/玩家信息；

函数原型：

setRoleInfo(
      String businessId,
      String roleId,
      String roleName,
      String roleAccount,
      String roleServer,
      int serverId,
      String gameJson)

参数说明：

gameJson 字段说明：

示例代码：

let json = {GameVersion: 'testGameVersion', AssetVersion: 'testAssetVersion'};
let stringJson = JSON.stringify(json);
htp.setRoleInfo({
    businessId: 'xxxxxxxxxxxxxxxxxxxxx',
    roleId: 'testroleId' ,
    roleName: 'testroleName' ,
    roleAccount: 'testroleAccount' ,
    roleServer: 'testroleServer' ,
    serverId: 1 ,
    gameJson: stringJson ,
}, e => {
    // 回调函数
    uni.showToast({
        title: '响应数据：' + JSON.stringify(e),
        icon: 'none'
    });
})

函数返回：

• 注：iOS没有回调值

• 回调参数说明：

  回调参数	类型	描述
  code	int	0:成功 -201:未初始化 -203:businessId 不合法 400:插件调用异常

登出接口

接口用途：

为了更好地统计该用户/玩家角色在本次登录后的行为，精准标识和打击有恶意行为的用户/玩家。

接入须知：

1. 须在 SDK 初始化接口被调用后方可调用，在用户/玩家退出当前角色（包括切换角色）或者退出游戏时调用接口。
2. 此接口主要用于判断用户/玩家本次生命周期，不强制要求接入。
3. 如果未调用初始化，此接口默认为空，不会执行任何逻辑。

函数原型：

logOut()

示例代码：

Future<void> logOut()

获取凭证

接口用途：

用于关键业务节点风险防控场景中，比如注册、登录、领劵、抽卡、兑换、点赞、评论等业务场景。业务方可通过此接口，获取检测唯一凭证 token。业务服务端通过此凭证实时获取当前用户/玩家风险检测结果，并根据结果进行处置。

接口适用场景为:
1、游戏类应用，当 SDK 数据上报接口被屏蔽导致数据上报失败时，通过 getToken 接口获取 SDK 采集信息，并由客户服务端传递给易盾服务器；
2、全类型应用，在关键业务节点主动调用检测时，通过 getToken 接口获取检测凭证，由客户服务端通过 token 凭证从易盾服务器查询检测结果。

接入须知：

1. 需要在 SDK 初始化且用户同意隐私政策后才能调用该接口，网易易盾隐私说明。
2. 该函数内部会进行网络请求。

函数原型：

getToken(int timeout, String businessId)

参数说明：

• 入参说明：

  参数	说明	必要性
  businessId	业务 ID	必填，由易盾后台分配，并在官网“服务管理”中查询
  timeout	函数超时时间	必填，单位毫秒，[1000,10000]，此区间外的默认为300

• 回调参数说明：

  回调参数	类型	描述
  code	int	结果码，不同结果码含义如下： 201：SDK未初始化； 203：businessId不合法； 204：其他情况 400:插件调用异常
  token	String	当 code 为200时，返回正常token。当网络状态不佳或者超时时，会返回离线 token

示例代码：

htp.getToken({
    timeout: 1000,
    businessId: 'ab51b8dbadb6894192eeeaafd6973d0e',
}, e => {
    // 回调函数
    uni.showToast({
        title: '响应数据：' + JSON.stringify(e),
        icon: 'none'
    });
})

交互接口（ioctl）

接口用途：

用于在客户端查询 SDK 采集的基础数据、设置需要传递给 SDK 数据（比如初始化配置内容、check 结果信息等）、及其他可能的定制功能服务。

接入须知：

接口调用前置条件是：调用了初始化接口并且同意隐私政策之后。

函数原型：

ioctl(int request, String data)

参数说明：

Android：

• 入参说明：

  参数	说明	必要性
  request	1 ：模拟器名称签名信息 2 ：是否root 3 ：本地随机生成的设备ID 7 ：SDK版本 9 ：加密后的当前SDK版本 14： SDK运行状态，应对线程被挂起或其他导致无法运行时但是接口正常使用的状态 16 ：初始化配置内容，防止初始化失败情况下，客户可以通过服务端请求初始化配置并传递给SDK 17 ：客户服务端将check结果传递给SDK，便于执行后续动作	必填
  data	设置信息的附加数据	可选，不需要可填null

• 回调参数说明：

  回调参数	类型	描述
  msg	String	入参 request = 1 ,msg: 返回模拟器名称，示例：emulator：Nox；若为未知模拟器，则返回：emulator：Unknown；若为真机，则返回：emulator：None 入参 request = 2, msg: 当前设备是否root信息。若为root设备，返回值为：root：1；若不是root设备，返回值为：root：0 入参 request = 3, msg: 当前设备id，比如“c09cb89662e6719f956f23651be42006” 入参 request = 7, msg: 风控 SDK 版本号一定不为空，返回值示例：“5.3.5” 入参 request = 9, msg: 风控 SDK 版本号一定不为空，返回值示例：“iF13uXaKVteXVA==||58807f98da0d945b5d60ba4e8f22a428"，解密方式请联系易盾技术支持 入参 request = 14, msg: 返回值为字符串格式： -1：SDK未启动 0：运行正常 大于0：运行异常 入参 request = 16, msg: {"s":0,"v":33554433} //s：状态，int类型，只有为0，v 字段的值才有意义; // v：版本，long类型(8字节)，配置的版本 入参 request = 17, msg:返回值为字符串格式： 0或者-1,输入数据格式有误;1为解析成功

IOS：

• 入参说明：

  参数	说明	必要性
  request	对应向风控系统请求的命令：0 ：签名信息 2 ：越狱状态 7 ：SDK版本 16 ：初始化配置内容，防止初始化失败情况下，客户可以通过服务端请求初始化配置并传递给SDK 17： 客户服务端将check结果传递给SDK，便于执行后续动作 99 ：32位deviceID 100 ：64位deviceID	必填
  data	设置信息的附加数据	可选，不需要可填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解析成功