> >

资源与概述

本文用于详细说明设备验前端相关的所有配置和接口。

环境需求

条目
兼容性 IE9+、Chrome、Firefox、Safari、Opera、主流手机浏览器、iOS 及 Android上的内嵌Webview

安装

引入初始化Js

gd.js下载地址: https://static.geetest.com/g5/gd.js

<script src="https://static.geetest.com/g5/gd.js"></script>
// js文件会不定期升级更新,建议直接使用线上地址。

配置参数

这里说的配置参数,是指调用设备验时传入的 config 对象(key-value 结构),也就是调用初始化函数 initGeeGuard 时所传入的第一个参数的可选参数配置

除了appId,其它均为可选配置参数(以下配置参数除非您知道如何去使用,否则不要去设置(可能在不同的场景下带来副作用)):

参数 必填 类型 说明 默认值 可选值
appId
Y
string 设备验 id,极验后台申请得到
offline N boolean 是否本地生成geetoken false
protocol N string 协议头 默认去当前页面的协议头(本地或者混合开发一定要手动设置,否则一般会自动取到file协议) http://、https://
networkTimeout N number 设置验证过程中单个请求超时时间 10000(ms) 大于0的整数
apiServers N array 控制api请求的地址 [‘riskct.geetest.com’]
staticServers N array 控制静态资源请求的地址 [‘static.geetest.com’]
customInfo N string 唯一标记本次业务的流水号或凭证,用于防止 GeeToken 从业务场景剥离

调用初始化函数

1.在后台注册 AppID

2.初始化时appId为必传

initGeeGuard({appId:'xxxxxxxxxxxxxxx'},function(data){
// 获取到gee_token处理业务逻辑
if(data.status === 'success'){
data.data.gee_token
}
})

// 请求成功返回示例
{
"status": "success",
"data": {
"gee_token": "znqlmmF+XoPIKni/RmECLzEnJhYMKxkN3g1DQGtqdVth2NKTmucUE+ETx4EbAmMGfPcuujQuRn20bL+W4MWJzyXCJI5jUf0vgwTop3+iFnJb9oswpNb+Sl1b7bwevtrXtHWGRDsbKkKCyBmo4Mn8gHphX6bBAZEAUko+CfI0tPo3A+WUwQoEbPJy+D+RdIpqr52Z5KteraDnPEL1NiHxZ3OKpqfiZvDsiuvlPY7QQcQD3LEGGdI0z89rTNQG5C+fHLI0Rd0vXOMtcobEN2esVt5FLaaPHxPq5LsY0SQoQhqjh5zrC+FpKL6Qa9GiTk2asU3RchYE3lkscPYZq07OryaDs1fELaGufCJm5/202tAFpgSJddNQF9yH9jz6WE65prI2NfhSnfxZlvAJijEFi/bhp83ilDsMvt0jYLnAU0sTcRILFTpffduKqujJHn8+"
}
}

// 请求失败返回示例
{
"status": "error",
"data": {
"code": -50101,
"msg": "not app_id"
}
}

获取结果

将 GeeToken 和业务数据一起提交到业务的服务端, 服务端再向极验设备指纹服务查询结果。请参考服务端接入文档。

更新说明

版本号 更新内容 日期
1.2.1 1. 功能升级及优化
2. 升级安全能力
2024-06-27
1.2.0 1. 功能升级及优化
2. 升级安全能力
2024-05-23
1.1.0 1. 功能升级及优化 2024-02-21
1.0.9 1. 功能升级及优化 2023-12-19
1.0.8 1. 功能升级及优化 2023-11-17
1.0.7 1. 升级安全能力 2023-10-27
1.0.6 1. 修复已知问题
2. 升级安全能力
2023-04-21
1.0.5 1. 修复已知问题 2023-04-14
1.0.4 1. 功能升级及优化 2023-02-16
1.0.3 - 2022-11-07
1.0.2 - 2022-08-16