全部产品
阿里云办公

PC-WEB版本

更新时间:2018-02-27 15:06:02

简介

滑动验证是服役于阿里巴巴人机识别第一线的验证码产品。用户通过简单的右滑交互,无需思考即可通过验证。滑动验证web

资源引入说明

使用PC版滑动验证码,需要引入以下js资源:

  1. <!-- 国内使用 -->
  2. <script type="text/javascript" charset="utf-8" src="//g.alicdn.com/sd/ncpc/nc.js?t=2015052012"></script>
  3. <!-- 若您的主要用户来源于海外,请替换使用下面的js资源 -->
  4. <!-- <script type="text/javascript" charset="utf-8" src="//aeis.alicdn.com/sd/ncpc/nc.js?t=2015052012"></script> -->

其中,t字段建议设置为小时级别时间戳,随时间更新,确保js不会被浏览器长时间缓存,这样能够享受到我们针对js的动态发布迭代。

完整接入demo

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8" />
  5. <!-- 国内使用 -->
  6. <script type="text/javascript" charset="utf-8" src="//g.alicdn.com/sd/ncpc/nc.js?t=2015052012"></script>
  7. <!-- 若您的主要用户来源于海外,请替换使用下面的js资源 -->
  8. <!-- <script type="text/javascript" charset="utf-8" src="//aeis.alicdn.com/sd/ncpc/nc.js?t=2015052012"></script> -->
  9. </head>
  10. <body>
  11. <div id="your-dom-id" class="nc-container"></div> <!--No-Captcha渲染的位置,其中 class 中必须包含 nc-container-->
  12. <script type="text/javascript">
  13. var nc_token = ["CF_APP_1", (new Date()).getTime(), Math.random()].join(':');
  14. var NC_Opt =
  15. {
  16. renderTo: "#your-dom-id",
  17. appkey: "CF_APP_1",
  18. scene: "register",
  19. token: nc_token,
  20. customWidth: 300,
  21. trans:{"key1":"code0"},
  22. elementID: ["usernameID"],
  23. is_Opt: 0,
  24. language: "cn",
  25. isEnabled: true,
  26. timeout: 3000,
  27. times:5,
  28. apimap: {
  29. // 'analyze': '//a.com/nocaptcha/analyze.jsonp',
  30. // 'get_captcha': '//b.com/get_captcha/ver3',
  31. // 'get_captcha': '//pin3.aliyun.com/get_captcha/ver3'
  32. // 'get_img': '//c.com/get_img',
  33. // 'checkcode': '//d.com/captcha/checkcode.jsonp',
  34. // 'umid_Url': '//e.com/security/umscript/3.2.1/um.js',
  35. // 'uab_Url': '//aeu.alicdn.com/js/uac/909.js',
  36. // 'umid_serUrl': 'https://g.com/service/um.json'
  37. },
  38. callback: function (data) {
  39. window.console && console.log(nc_token)
  40. window.console && console.log(data.csessionid)
  41. window.console && console.log(data.sig)
  42. }
  43. }
  44. var nc = new noCaptcha(NC_Opt)
  45. nc.upLang('cn', {
  46. _startTEXT: "请按住滑块,拖动到最右边",
  47. _yesTEXT: "验证通过",
  48. _error300: "哎呀,出错了,点击<a href=\"javascript:__nc.reset()\">刷新</a>再来一次",
  49. _errorNetwork: "网络不给力,请<a href=\"javascript:__nc.reset()\">点击刷新</a>",
  50. })
  51. </script>
  52. </body>
  53. </html>

参数详细说明

参数 含义 是否必填项
renderTo 声明滑动验证需要渲染的目标元素ID
appkey 应用标示。它和scene字段一起决定了滑动验证的业务场景与后端对应使用的策略模型。您可以从console的配置里找到它正确的值,请勿乱写
scene 场景标示。它和appkey字段一起决定了滑动验证的业务场景与后端对应使用的策略模型。您可以从console的配置里找到它正确的值,请勿乱写
token 滑动验证码的主键,请务必不需要写死固定值。请确保每个用户每次打开页面时,token都是不同的。建议格式为”您的appkey”+”时间戳”+”随机数”
customWidth 滑动条的长度,建议预留300像素以上
trans 业务键字段。您可以不写此字段,也可以按照下文中”问题排查与错误码”部分文档配置此字段,便于线上问题排查
elementID 通过Dom的ID属性自动填写trans业务键,您可以不写此字段,也可以按照下文中”问题排查与错误码”部分文档配置此字段,便于线上问题排查
is_Opt 是否自己配置底层采集组件。如无特殊场景请保持写0或不写此项。默认为0
language 语言。PC场景默认支持18国语言,详细配置方法请见下方”自定义文案与多语言”部分。默认为cn(中文)
isEnabled 是否启用,无特殊场景请默认写true。默认为true
timeout 内部网络请求的超时时间,一般不需要改,默认值为3000ms
times 允许服务器超时重复次数,默认5次
apimap 用于自己指定滑动验证各项请求的接口地址。如无特殊情况,请不要配置这里的apimap
callback 前端滑动验证通过时会触发此回调,您可以在这个回调中将token、sessionid、sig记录下来,随业务请求带到您的server端调用验签

方法详细说明

noCaptcha对象中维护了一些方法提供给您使用,您可以通过诸如var nc = new noCaptcha(NC_Opt); nc.functionName(parm);的方式来调用使用它们。

方法名 参数 作用
reload 任何时候调用此方法,可以将滑动验证重置为初始状态(等待滑动)
hide 任何时候调用此方法,可以隐藏滑动验证组件
show 在调用hide方法后,任何时候调用此方法,可以展示滑动验证组件
getToken 任何时候调用此方法,可以获取当前滑动验证实例的token
setTrans Object 可以设置滑动验证的业务键,方便问题排查定位。详见”问题排查与错误码说明”部分
upLang String,Object 用于配置NC自定义文案,详见”自定义文案与多语言”部分
destroy 销毁当前滑动验证实例

测试指南

(1) CF_APP_1复现验证码各个状态机

CF_APP_1这个appkey是验证码服务专门为用户测试验证码各个状态所维护的appkey。启用这个appkey后,您可以通过配置前端trans字段来直接控制验证码服务接口的返回(通过or拦截),借此您可以直观的看到验证码各个状态的交互、样式和流程。正式上线时请务必将其替换为阿里云控制台上为您分配的appkey和scene,以免出现不必要的安全问题。
CF_APP_1下trans字段与验证码结果对应关系如下:

trans 效果
{“key1”:”code0”} 滑动一定会通过
{“key1”:”code300”} 滑动一定会被拦截

(2) 正式上线测试

正式上线之前,推荐您执行完整的功能性和兼容性测试。测试过程中有以下几点注意事项:
·请确保您使用阿里云控制台上分配的appkey和scene进行测试,不要胡乱填写
·请注意您当前验证码的使用场景。如果您的验证码在PCweb场景下使用,请不要用手机等移动设备进行测试
·在测试低版本IE浏览器时,不要用IE11浏览器的兼容模式去模拟生成低版本浏览器。请用真正低版本IE浏览器进行测试

自定义样式:HTML结构与CSS定制说明

(1) HTML结构图示

滑动验证PCweb环境下的Dom结构如下图所示滑动验证1滑动验证2

(2) 颜色、图标自定义

您可以通过自定义CSS的方式来覆盖滑动验证各个UI组件的颜色、资源等,注意自定义样式需出现在滑动验证自带样式的后方,必要时可添加 !important滑动验证3

  1. .nc_scale {
  2. background: #e8e8e8; /* 默认背景色 */
  3. }
  4. .nc_scale .scale_text {
  5. color: #9c9c9c; /* 默认字体颜色 */
  6. }
  7. .nc_scale div.nc_bg {
  8. background: #7ac23c; /* 滑过时的背景色 */
  9. }
  10. .nc_scale .scale_text2 {
  11. color: #fff; /* 滑过时的字体颜色 */
  12. }
  13. .nc_scale span {
  14. border: 1px solid #ccc;
  15. background: #fff url("//g.alicdn.com/sd/ncpc/images/rt.png") no-repeat center;
  16. }
  17. .nc_scale .btnok {
  18. background: #fff url("//g.alicdn.com/sd/ncpc/images/yes.png") no-repeat center;
  19. }
  20. .errloading {
  21. border: #faf1d5 1px solid;
  22. background: url("//g.alicdn.com/sd/ncpc/images/no.png") #fffff0 no-repeat 10px 9px;
  23. color: #ef9f06;
  24. }

自定义文案与多语言

(1) 多语言

滑动验证默认支持18国语言,您可以通过滑动验证配置项中的language字段来进行选择(默认为cn,中文)

ar_SA:阿拉伯文
de_DE:德文
es_ES:西班牙文
fr_FR:法文
in_ID:印尼语
it_IT:意大利文
iw_HE:希伯来语
ja_JP:日文
ko_KR:韓文
nl_NL:荷蘭文
pt_BR:波蘭文
ru_RU:俄文
th_TH:泰文
tr_TR:土耳其文
vi_VN:越南文
cn:简体中文
tw:繁体中文
en:英文

(2) 自定义文案

您可以通过滑动验证对象维护的upLang方法来自定义您需要的文案。内置的语言有简体中文、繁体中文、英文(cn、tw、en)三种,可以选择其中一种进行更新,也可传入一个新名字以建立新语言。如果您调用upLang方法后,自定义文案没有生效,请在其之后调用reload()方法,让滑动验证重新渲染即可

  1. /**
  2. * @param name {string} 语言名,可选 cn、tw、en ,也可添加自定义语言
  3. * @param detail {object} 语言详情,key/value 格式
  4. */
  5. nc.upLang('cn', {
  6. _startTEXT: "请按住滑块,拖动到最右边",
  7. _yesTEXT: "验证通过",
  8. _error300: "哎呀,出错了,点击<a href=\"javascript:__nc.reset()\">刷新</a>再来一次",
  9. _errorNetwork: "网络不给力,请<a href=\"javascript:__nc.reset()\">点击刷新</a>",
  10. })

问题排查与错误码说明

(1) 上传业务键

滑动验证默认不会采集您当前业务场景下的用户名、手机号等业务键,为了方便问题排查,这里强烈建议您配置上传业务主键,这样遇到问题的客户可以提供”业务键+时间”,很方便的关联到对应滑动验证的请求。否则您必须提供引导用户进行抓包才能具体对应查到日志和请求。
您有两种方法可以上传业务键:
a. 您可以在用户操作滑块前的任何时刻调用滑动验证维护的setTrans方法上传。比如您可以在用户填写完用户名(从用户名输入框失焦)时调用nc.setTrans({‘userName’:用户名输入框value})来上传用户名;也可以在页面加载完毕的时候调用nc.setTrans({‘业务会话标示’:业务会话session的值})来上传您业务上唯一的会话标示。
b. 您也可以配置elementID来让滑动验证主动采集。elementID的值为一个stringList,配置之后在滑动结束的时刻,滑块会以elementID当中的每一个string作为ID,去获取对应dom的value值并上传。举个例子,如果您配置elementID:[“usernameID”],则滑动结束时document.getElementById(“usernameID”).value会自动被上传至滑动验证服务端。

(2) 错误码

滑动验证发生异常的情况下,在错误信息后会附带错误码,如下图:滑动验证4

其中错误码含义如下:

错误码 含义
00 analyze请求超时
01 uab.js加载超时
02 um.js加载超时
04 设备指纹代码加载异常
08 waitForUmx超出重试次数