接入说明

最近更新时间:2020-07-10 18:25:57

目录

一、概述

本文是kscop API H5的部署文档,用于指导 kscop API H5的集成。

二、安装

  • 页面引用kscop.js
  • 初始化KSCOP对象

字段说明: app_id 为客户在金山云后台申请的。审核成功后生效

var opKscop = new KSCOP({            
    app_id: appId, // 客户在金山云后台申请的。审核成功后生效
    timeout: 3000, // 超时
    pre_init: true // 是否初始化时获取运营商参数
});
  • 网络状态判断方法(非必选)

说明:该方法可提升非纯4G网络环境下用户的使用体验,为可选方法,不使用该方法不影响正常接入使用。

// 判断网段
var net = KsInstance.checkNetInfo();
// 如果是Wi-Fi提示 打开流量
if(net !== 'wifi') {
    // 调用网关
    KsInstance.gateway({phone:13333333})
}else {
    // 不调用网关验证 弹出提示(可根据具体的业务场景)      
}
  • 调用网关接口
KsInstance.gateway({phone: 133333333333})
  • 调用onGatewaySuccess、onGatewayFail 获取校验结果
// 网关调用成功后触发
opKscop.onGatewaySuccess(function(data){
    // 调用后端校验接口,获取是否是本机校验结果
    $.ajax({
        method: 'POST',
        url: '后端接口',
        data: '参数',
        success:function(data){
            // 校验是否是本机结果
        },
        error: function(data) {
            // 失败
        } 
    })

})
// 网关调用失败后触发
.onGatewayFail(function(data){
    // 网关失败 弹出错误提示
})
  • 请在head中添加代码
<meta content="always" name="referrer">

方法说明

gateway(options) 调用网关

参数options结构: { phone: ‘13333333333’ },传入需要校验的号码。

onGatewaySuccess(fn)网关成功返回

fn 成功返回函数,返回函数参数是Object, 结构:{ process_id: ‘xxxx’, phone:’13333333333’, accesscode: ‘abc’ }。

onGatewayFail(fn) 网关失败返回

fn 失败返回函数,返回函数参数是Object, 结构:{ code: 100 },错误码参考说明

checkNetInfo() 返回当前网络状态

返回cellular、wifi、unknown 三种状态。建议网络状态为cellular和unknown情况时调用网关接口,网络状态为wifi时不调用网关接口。

三、错误码

错误码 说明 常见原因 解决方法
100 pre_gateway接口网络失败 断网,超时或者跨域 检测网络
101 pre_gateway接口返回数据错误 数据格式不对 查看文档确认格式正确
102 接口网络失败 断网,超时或者跨域 检测网络
103 电信接口失败 是否是数据网络 检测网络,服务查看日志
104 移动接口失败 是否是数据网络,备案refer是否与当前页面refer一致 检测网络,确认备案refer, 服务查看日志
105 record_token接口网络失败 断网,超时或者跨域 检测网络
106 record_token接口失败 是否是数据网络 检测网络,服务查看日志
107 联通接口失败 是否是数据网络 检测网络,服务查看日志
108 切换运营商接口失败 超时接口错误 检测网络,服务查看日志

金山云,开启您的云计算之旅

免费注册