WEB/WAP/H5端接入教程
2024.04.18 15:59:00
接入说明
接入“智能风控”JS SDK开发者需要完成以下步骤:
1. 引入/安装js SDK文件
2. 初始化SDK
3. 在需要检测的位置,调用getToken接口
4. 测试验证SDK接入成果
接入步骤
请登录易盾官网后台风控引擎-服务管理获取SDK,详情如图。
引入/安装JS SDK
通过<script>
引入JS, 请注意需要放在初始化代码之前。
示例代码:
<script src="./YiDunProtector-Web-1.0.0.js"></script>
部分产品相关参数请用账号登陆易盾官网控制台获取参考
初始化SDK
调用init接口执行SDK初始化。
示例代码:
const neg = createNEGuardian({ appId: '<APP_ID>', timeout: 10000 })
其中:
appId
是应用标识,对应易盾控制台中的产品编号,YD开头;
timeout
数据请求超时时间,单位 ms,默认 6000
。
注:不可用的appId会导致服务端鉴权接口失败,请确保appId是正常可用的。
私有化初始化SDK
执行私有化 SDK 初始化。 示例代码:
const neg = createNEGuardian({ appId: '<APP_ID>', apiServer:'https://xxxxx.xxxx.xxxx', timeout: 10000 })
其中: appId 是应用标识,对应易盾控制台中的产品编号;apiServer 私有化服务器地址,私有化的客户需要通过该接口设置服务器地址,其他客户可以忽略; timeout 数据上报超时时间,单位 ms,默认 6000。 注:不可用的appId会导致服务端鉴权接口失败,请确保appId是正常可用的。
调用getToken
在需要检测的位置调用接口getToken,上报信息并获取查询凭证。
示例代码:
neg.getToken().then(result => {
if (result.code === 200) { // 正常情况
alert('get token:', result.token)
}
if (result.code === 201) { // 离线模式
alert('get token:', result.token)
}
})
getToken 返回有两种模式:
- 正常模式,数据正常上报到设备指纹服务端,token长度固定;
- 离线模式,数据上报过程中出现异常,比如网络抖动/超时等,token长度不固定,请注意做兼容处理。
验证SDK接入成果
前端获取到 token
后,将 token
上传到业务服务器;
业务服务器根据 token
向智能风控服务器发起校验,查询结果;
更多token使用细节见智能风控服务端在线检测接口(check)。