vaptcha-sdk

Vaptcha Sdk for NodeJs

Step1.环境准备

• Vaptcha SDK NodeJs版本适用于 node 4.0及以上版本。
• 要使用Vaptcha SDK，您需要一个Vaptcha账号、一个验证单元以及一对VID和Key。请在Vaptcha验证管理后台查看

Step2.SDK 获取和安装

• 使用命令从Github获取:

  git clone https://github.com/vaptcha/vaptcha-node-sdk.git

  github下载地址手动下载获取。

• 推荐使用npm安装:

  npm install vaptcha-sdk --save
  

• 运行demo

  demo的vid和key由vaptcha官方免费提供，只可在localhost:4396下使用，缺少一些限制，可能存在安全隐患。在实际生产环境中，我们建议你登陆vaptcha管理后台，在验证管理中添加对应的验证单元，并把domain参数设置为实际环境中的域名。

  git clone https://github.com/vaptcha/vaptcha-node-sdk.git
  cd vaptcha-node-sdk
  npm install
  npm start

  打开http://localhost:4396/demo即可访问

Step3.SDK接口

使用接口前需先实例化Vaptcha

const Vaptcha = require('vaptcha-sdk'); //引入sdk
new Vaptcha(vid, key);// 实例化sdk，vid 和 key 对应验证单元中的vid和Key

SDK提供以下三个接口：

• 获取流水号接口 getChallenge(sceneId) ，返回Promise对象

  参数说明:

  sceneId： 选填，场景id，请在vaptcha管理后台查看

• 宕机模式接口 downTime(data)，返回Promise对象

  参数说明:

  data： GET请求返回的字段名为data的数据。

• 二次验证接口 validate(challenge, token[, sceneId])，返回Promise对象

  参数说明:

  challenge： 必填，客户端验证通过后返回的流水号

  token： 必填， 客户端验证通过后返回的令牌

  sceneId： 选填，场景id，与getChallenge(sceneId)的场景id保持一致