## 兼容性
IE7+、Chrome、Firefox、Safari、Opera、主流手机浏览器、iOS 及 Android上的内嵌Webview
## 开始使用
### 引入初始化JS
http示例如下：
Code (html):
https示例如下：
Code (html):
地址中的t参数强烈建议设置为分钟级别时间戳，避免该文件被浏览器长时间缓存。示例见完整示例
### 调用初始化函数
initNECaptcha(config, onload, onerror)
Code (js):
// initNECaptcha为全局函数，可直接调用
initNECaptcha({
// config对象，参数配置
captchaId: '从易盾申请的captchaId',
element: '#captcha',
mode: 'float',
width: '320px'
}, function onload (instance) {
// 初始化成功后得到验证实例instance，可以调用实例的方法
}, function onerror (err) {
// 初始化失败后触发该函数，err对象描述当前错误信息
})
## 参数配置
这里指初始化时传入的config对象，即调用初始化函数initNECaptcha时传入的第一个参数。智能无感知验证码设置参数有些不同，详见表格下方特别说明。
参数 | 参数类型 | 必填 | 默认 | 说明
captchaId | string | 是 | 无 | 验证码id
element | string/HTMLElement | * | 无 | 容器元素或容器元素选择器。当mode是"popup"且用户使用表单提交时，必填；mode是"float"或"embed"时均是必填
mode | string | 否 | PC端默认"float"，移动端默认"popup" | 验证码模式，常规验证码三种模式可选："float"、"embed"、"popup"，即触发式、嵌入式、弹出式。智能无感知验证码类型可设置"bind"模式，绑定自有按钮模式
protocol | string | 否 | 与用户网站的网络协议一致 | 验证码传输数据使用的网络协议，可选："http"、"https"
width | number |string | 否 | "auto" | 验证按钮宽度，推荐使用宽度260px-400px。类型为string时，支持后缀px、rem、%，类型为number时，内部会将其转换成px单位的值。"auto"时，其宽度与容器元素宽度一致。mode为"popup"时，百分比单位无效。
lang | string | 否 | "zh-CN" | 验证码语言选项。支持"zh-CN"-简体中文"、"zh-TW"-繁体中文、"en"-英语、"ja"-日语、"ko"-韩语、"th"-泰语、"vi"-越南语、"fr"-法语、"ru"-俄语、"ar"-阿拉伯语
appendTo | string/HTMLElement | 否 | 无 | 验证码弹框的指定区域元素或者指定区域元素选择器。该配置仅在popup模式、bind模式及H5下的智能无感知类型有效。请注意，指定区域的元素必须为非静态定位
onReady | function | 否 | 无 | NECaptcha所有工作准备就绪，用户可以使用验证码时触发该回调。具体使用见完整示例
onVerify | function | 否 | 无 | 验证码验证结束回调函数。具体使用见完整示例
onClose | function | 否 | 无 | 验证码关闭弹框后回调函数。具体使用见完整示例
enableClose | boolean | 否 | false | 由业务方控制验证码弹框关闭，具体使用见完整示例
extraData | String/Function | 否 | 无 | 如果需要在check阶段透传业务数据，可以使用extraData配置，支持字符串和函数，函数可以解决动态数据问题。当调用二次校验结果接口时，会原样返回该字段，详见后端响应参数 (http://support.dun.163.com/documents/15588062143475712?docId=69218161355051008)。
[md-attention]
#### 特别注意
对于智能无感知验证码，参数mode只可设置bind，其他值无效；当mode为非bind时，width设置无效，验证按钮宽度与容器宽度一致，容器宽度最小240px。当mode为bind时，验证码宽度等于width值。
对于指定弹框区域的验证码，参数appendTo表示的元素必须为非静态定位，即position不能为static。
## 实例方法
这里指initNECaptcha初始化成功，onload触发时传入的实例的方法。
- refresh：刷新验证码，获取新的验证信息，具体见onVerify示例。
- destroy：销毁当前实例
- popUp：当验证码是常规验证码并且mode为"popup"时，可调用该实例方法弹出验证码进行验证
- close：当验证码为popup弹框样式，且开启enableClose时，可调用该实例方法关闭验证码弹框
示例：
Code (js):
initNECaptcha(config, function onload (instance) {
// 可在此处调用实例方法
}, onerror)
## 完整示例
### 使用时间戳引入初始化js
Code (js):
var url = 'http://cstaticdun.126.net/load.min.js' + '?t=' + getTimestamp(1 * 60 * 1000) // 时长1分钟，建议时长分钟级别
loadScript(url, function () {
// 进行初始化验证码等后续逻辑
// initNECaptcha({
// captchaId: '从易盾申请的captchaId',
// element: '#captcha',
// width: '320px'
// })
})
function getTimestamp (msec) {
msec = !msec && msec !== 0 ? msec : 1
return parseInt((new Date()).valueOf() / msec, 10)
}
function loadScript (src, cb) {
var head = document.head || document.getElementsByTagName('head')[0]
var script = document.createElement('script')
cb = cb || function () {}
script.type = 'text/javascript'
script.src = src
if (!('onload' in script)) {
script.onreadystatechange = function () {
if (this.readyState !== 'complete' && this.readyState !== 'loaded') return
this.onreadystatechange = null
cb(script)
}
}
script.onload = function () {
this.onload = null
cb(script)
}
head.appendChild(script)
}
### 使用form表单
Code (html):
验证码示例
### 使用popup弹出模式
Code (html):
验证码示例-popup模式
### 智能无感知bind模式
- 当验证码是智能无感知时，且设置 mode为 ‘bind’ 时，可以通过调用实例的 verify 接口进行手动验证，实现绑定自有按钮的无感知验证
- 这种形式的好处是，用户可以在验证验证码之前做一些自定义的事件（比如表单参数处理验证），通过后再决定是否调用验证接口
- 验证码验证成功之后在 onVerify 的回调里面做实际的提交行为
Code (html):
验证码示例-智能无感知bind模式
### 使用onVerify获取验证结果回调
Code (html):
验证码示例
### 使用appendTo（用于指定弹框区域）
Code (html):
验证码示例
[md-note]
#### 特别说明
- onload和onReady的区别：
onload和onReady触发时，均会返回验证码的实例，即传入的第一个参数。二者触发时机有所不同，onload触发时，初始化函数结束和完成实例的生成，注意这并不代表验证码是可用的（比如验证码相关背景图片和信息并没有加载），此方法只触发一次。onReady触发时，说明验证码准备就绪（比如背景图片等信息均已加载），在popup模式下，每次弹出均会触发onReady，其他模式下onReady只触发一次。