Web

概述及资源

环境需求

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

资源链接

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

demo地址

在线demo:http://www.geetest.com/demo/sense.html

Node示例demo下载

安装

  1. 引入初始化函数

    <script src="gt.sense.js"></script>

    需要说明的是这里的gt.sense.js文件,它用于加载对应的验证JS库,开发者可直接在各版本demo中获得并保存至自己的项目中使用。

  2. 调用初始化函数进行初始化

    引用js后,请立即调用initSense,保证尽早收集数据。

    当用户完成常规交互后,在核心提交事件提交时调用sense方法。

    initSense({
    id:'95da05c7809ec08cf97cfb2e932cd381',
    onError:function(err){
    console.log('gt error', err)
    }
    }, function(sense){
    $('#btn').click(function () {
    // 请先检查必现输入的数据, 例如:用户名,密码

    sense.sense()
    });
    sense.setInfos(function () {
    //设置可上传数据。请务必按照字段规范填写,否则会在服务验证时出错,导致程序无法运行或者后续数据分析出现混乱,参数需求参考api文档。
    return {
    interactive: 1
    }
    }).onSuccess(function (data) {
    $.ajax({
    url: '您的服务',
    type: "post",
    dataType: "json",
    data: {
    phone: document.getElementById("phone"),
    password: document.getElementById("password"),
    challenge: data.challenge
    },
    success: function (result) {
    console.log(result);
    }
    })
    }).onClose(function(){
    console.log('close')
    }).onError(function(err){
    console.log(err);
    })
    });

以上初始化过程,需要结合服务端 demo 使用,因为验证接口需要调用服务。

配置参数

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

以下为必需配置的参数:

参数 类型 说明
id 字符串 验证 id,极验后台申请得到

以下为可选配置参数:

参数 类型 说明 默认值 可选值
lang 字符串 设置验证界面文字的语言 zh-cn zh-cnzh-twenjaid
https 布尔 是否使用https请求 false true hybrid开发使用请设置true
timeout 数字 设置验证过程中单个请求超时时间 30000(ms) 可以按需配置
area 字符串 设置后续弹出的验证的区域 默认为body 可以按需配置
width 字符串 设置后续弹出的验证的宽度 默认为验证形式当前宽度 按需要设置,最宽支持348px,最小支持260px。
bg_color 字符串 设置弹出背景的颜色 默认为黑色,此时弹出背景的颜色为60%透明度的黑色。 按需要设置

lang

设置验证界面文字的语言。目前可选语言有:

  • zh-cn(简体中文)
  • zh-tw(繁体中文),
  • en(英文)
  • ja(日文)
  • id(印尼)

其它语言会陆续增加支持。设置为简体中文和英文时的效果图如下:

设置界面语言为英文

initSense({
// 省略必须的配置参数

lang: 'en'
});

https

设置验证是否使用https请求。常见的有 http://https://。默认值与宿主页面所使用的协议一致。

用户在 http:// 的页面上使用 https://
hybrid开发用户使用https

initSense({
// 省略必须的配置参数

https: true
});

实例

初始化

使用初始化函数 initSense 初始化后,它的第二个参数是一个回调,回调的第一个参数即是验证实例,如下代码所示。

initSense({
// 省略配置参数
}, function (sense) {
// 现在可以调用验证实例 sense的方法了
});