概述及资源

在您选择了对应的服务端 SDK 并运行 demo 后,可以看到一个简化了的使用验证的方式。也就是说在 demo 的基础上,我们还提供了其他常用的配置参数和接口。本文即用于详细说明验证前端相关的所有配置和接口。

环境需求

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

资源链接

条目
产品结构流程 通讯流程
接口文档 接口示例

安装

准备工作: 服务端部署完成(服务端部署文档)

  1. 引入初始化函数(gt.js文件存放于服务端SDK中,开始下载)
<script src="gt.js"></script>

注: 行为验证要求初始化在业务页面加载时同时初始化,否则验证无法读取用户在业务页面操作的行为数据,会导致验证策略失效。

需要说明的是这里的gt.js文件,它用于加载对应的验证JS库。目前我们在每个后端语言的sdk中都存有一份,开发者部署到实际项目时需要将该文件复制到相应的项目中去使用。

通过以上代码引入 `initGeetest` 初始化函数
  1. 调用初始化函数进行初始化
ajax({
url: "API1接口(详见服务端部署)",
type: "get",
dataType: "json",
success: function (data) {
//请检测data的数据结构, 保证data.gt, data.challenge, data.success有值
initGeetest({
// 以下配置参数来自服务端 SDK
gt: data.gt,
challenge: data.challenge,
offline: !data.success,
new_captcha: true
}, function (captchaObj) {
// 这里可以调用验证实例 captchaObj 的实例方法
})
}
})

注: 对于同一个页面存在多个验证码场景的初始化,需要每个验证码场景调用 initGeetest 方法单独进行初始化;如果一个场景下有多个验证入口,需要进行多次初始化。

配置参数

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

以下为必需配置的参数,建议按照上述示例代码方式填写

参数 类型 说明
gt 字符串 验证 id,极验后台申请得到
challenge 字符串 验证流水号,后服务端 SDK 向极验服务器申请得到
offline 布尔 极验API服务器是否宕机(即处于 fallback 状态)
new_captcha 布尔 宕机情况下使用,表示验证是 3.0 还是 2.0,3.0 的 sdk 该字段为 true

开发者只需要将服务端 SDK 返回的这几个配置参数按照 demo 中的方式传入即可。

以上是必需配置的参数,可选配置参数参考 Web API 的参数配置