一.准备工作

概述

本文是H5本机号校验 v1.0.1版本的接入文档，用于指导WEB应用开发人员接入，并详细描述接入流程和使用方法，默认读者已经具有一定的编程知识基础。

快速体验DEMO

请用手机浏览器上访问链接：http://test.login.253.com/demo/demo.html

创建应用

开发者使用账号登录控制台，进入控制台页面创建应用。然后进入“闪验认证-应用版本”中创建应用版本，填写登录页面地址和域名后提交，等待闪验运营人员审核。开发者可以在应用版本列表中查看当前应用版本的APPID和APPKEY。APPID是闪验的应用标识，APPKEY是闪验的应用秘钥，用作于调用闪验接口时的签名算法秘钥。

二.集成SDK

//在页面中引入闪验WEB-SDK的JS文件：
<script src="./shanyan.min.js"></script>;
//在页面中实例化SDK对象：
var login = new OneKeyLoginManager();

1.调用预签名

//调用SDK方法获取预签名：
var preSign = login.getPreSign();
//将preSign传到客户后台服务中，生签名成sign：

客户后台准备三个参数：

注：客户后台将参数字段名和字段值一起拼接为字符串使用Hmac-SHA256算法以appKey为   秘钥加密生成签名sign的值。算法伪代码：

var sign = Hmac_SHA256(
  "appId12345678preSignxxxxxxxxxxxxxxxxxxxxtimestamp13511112312312",
  appKey
);

//客户后台返回appId、sign、timestamp三个参数到WEB端。

2.调用初始化

Web端调用WEB-SDK init方法。

login.init({
  appId: yourAppId,
  timestamp: yourTimestamp,
  sign: yourSign,
  // timeout: 5,
  // mobile: 18xxxxxxxxx,
  callback: yourCallback,
});
//appId，timestamp，sign三个都是客户后台返回的参数，非空，字符串类型。
//timeout为超时参数，单位(秒)，本方法设置调用运营商接口的超时，可以为空(默认5s) ，数字类型 。
//mobile为用户在页面输入的手机号码，如果前端页面没有输入项，可以为空，用来辅助判断运营商， 字符串类型。
//callback为回调函数，回调函数中会返回运营商token值，非空，函数类型。
//callback示例：
function cb(info) {
  if (1000 === info.code) {
    // 初始化成功，获取token
    var token = info.extra.token;
  } else {
    // 初始化失败逻辑，根据业务需求自行实现
  }
}

获取token后将token和手机号码传入到客户后台，用于调用本机号校验接口，校验此token与手机号码是否匹配。如匹配则表示此号码是当前手机流量卡的手机号码，否则不是当前手机流量卡卡号。

ps:闪验支持手机号隐式校验，所以手机号码可以为用户在前端页面的输入值，也可以为客户后台保存的手机号码。

3.调用本机号校验接口

3.1.协议说明

3.2.请求参数

注：请求参数Body以application/x-www-form-urlencoded方式提交。

3.3.响应内容

注：响应body数据为JSON格式。

3.4.返回示例

{
  code: "200000",
  chargeStatus: 1,
  message: "成功",
  data: {
    tradeNo: "18112115031414011",
    isVerify: "1",
  },
}

三.本机号校验接口响应code码

四.常见问题

1.本机号校验接口错误：appId不能为空
{“message”:“请求非法，appId不能为空”,“code”:“403000”}
问题排查方案：
检查是否传入appId字段。请求数据格式是否正确，本接口不支持发送JSON格式数据。
问题解决方案：
首先，请核对字段名称无误，使用正确的字段名。
其次，请确保请求使用POST方法，参数放到RequestBody中以application/x-www-form-urlencoded或multipart/form-data提交。
 
2.本机号校验接口错误：请求非法，签名验证不通过
{“message”:“请求非法，签名验证不通过”,“code”:“403000”}
问题排查方案：
请确保签名生成方式无误。
问题解决方案：
1、首先确保使用了正确的应用对应的appKey。
2、其次请确保签名方式正确，签名字段的值由客户服务端生成，签名算法hmacSHA256(所有传入参数按字段名排序后拼接的字符串，应用appKey)后再进行16进制字符串转换的值。