设备风险SDK Web/H5接入

本文档介绍了设备风险SDK (Web/H5)的接入流程,在需要保护的页面嵌入JS SDK,注意:一个网页(包括单页应用)嵌入一次即可。

嵌入JS SDK

<script src="https://o.alicdn.com/captcha-frontend/aliyunFP/fp.min.js"></script>
重要

js文件会定期更新,为避免js失效影响您的使用,请不要将js下载到本地服务器上引入。

init接口

嵌入JS SDK之后,可以立即初始化SDK(只需初始化一次),以获取SDK对象。

初始化示例:

ALIYUN_FP.use('um', (state, um) => {
  if (state === 'loaded') {
    um.init({
        //这里填写风险识别控制台申请的 AppKey
        appKey: 'your_app_key',
        //这里填写 Web 应用名称,客户自定义
        appName: 'your_web_app_name'
        //endpoints : ['https://cloudauth-device.aliyuncs.com']
    });
  }
});
重要

如果不指定服务地址,则endpoints会读取默认配置。请务必将endpoints的域名添加至小程序后台白名单,以确保相关功能正常运行。

endpoints默认服务地址:

  • 中国内地(默认)服务地址:https://cloudauth-device.aliyuncs.com

  • 国际/中国香港服务地址:https://cloudauth-device.ap-southeast-1.aliyuncs.com

getToken接口

获取设备指纹deviceToken,建议在发起业务行为的时候再调用一次,和初始化接口之间的时间差至少2秒。

window.z_um.getToken();

接入示例

<body>
<button type="button" id='register' onclick="login();">登录</button>
<script type="text/javascript" src="https://o.alicdn.com/captcha-frontend/aliyunFP/fp.min.js"></script>
<script>

//在页面加载的时候第一时间初始化
ALIYUN_FP.use('um', (state, um) => {
  if (state === 'loaded') {
    um.init({
        appKey: 'your_app_key',
        appName: 'your_web_app_name'
        //endpoints : ['https://cloudauth-device.aliyuncs.com']
    }
  }
});

//处理业务函数,比如登录
function login(){
    //获取设备指纹的deviceToken,getToken和init之间最好相隔2s以上。
    deviceToken = window.z_um.getToken();
    //将deviceToken传入客户的服务后台
    var data = {
           "deviceToken": deviceToken,
           "其他业务参数":""
     };
    //发送后台请求...后台通过deviceToken查询风险信息
}

</script>
</body>

调用风险识别API接口

将 deviceToken 与其他参数,根据如下相应的风险识别服务事件参数文档说明,请求风险识别API接口进行识别: