接入说明

最近更新时间:2020-08-07 18:21:17

目录

一、概述

本文是OnePass API 小程序的部署文档,用于指导 OnePass API 小程序的集成。

二、安装

  1. 下载Demo
  2. 初始化onepass对象
  this.opInstance = new Onepass({
    app_id: '您申请的ID',
    timeout: 3000, // 超时时间,默认3000
    pre_init: true // 是否初始化时获取运营商参数;默认为true
  })
  1. 调用gateway方法,返回运营商地址

说明: 可调用小程序 wx.getNetworkType进行网络判断后调用gateway方法;该方法可提升非纯4G网络环境下用户的使用体验,为可选方法,不使用该方法不影响正常接入使用;

  this.opInstance.gateway('phone', function(err, url){
    if(!err){
      // 设置image控件的src属性
      that.setData({ operator_url: url })
    } else {
      // 失败,针对这种开发者可以接入短信,走短信通道       
    }
  })
  1. wxml文件中放入一个image控件,image的图片地址是运营商地址

    说明: 用户如果有多次请求gateway接口的业务需要,请在调用gateway方法前将image里的路径清空;this.setData({ operator_url: '')

<image style='width: 0; height:0' bindload='imgload' binderror='imgload' referrerPolicy="no-referrer" src="{{operator_url}}" wx:if="operator_url"></image>
  1. 在image控件的load和error事件处理函数中调用onepass的getTokenStatus方法

    this.opInstance.getTokenStatus(function(err, data){
    if(!err){
      // token调用成功,调用check gateway接口,服务端校验是否成功
    
    } else {
      // 失败,针对这种开发者可以接入短信,走短信通道
    }
    })
  2. 前往小程序后台添加request合法域名

配置列表

服务器配置 地址
request合法域名 https://onepass.geetest.com
https://id6.me
https://www.cmpassport.com
https://opencloud.wostore.cn
https://nishub1.10010.com:38750

Request合法域名在小程序开发后台(开发>开发设置)中设置,配置时请注意将上方地址全部加入到列表里,配置成功后需要大约10分钟左右后生效(小程序规定)

说明: 开发者在本地进行移动网络调试时,需要在真机调试模式下进行调试。

三、错误码

错误码 说明
100 gateway接口网络请求失败,网络超时或失败
101 gateway接口返回失败,检查app_id是否合法
102 电信接口网络请求失败,网络超时或失败
103 电信取号失败(检查是否开启4G,查看接口返回数据)
104 移动取号失败(检查是否开启4G,查看接口返回数据)
107 联通取号失败 (检查是否开启4G,查看接口返回数据)

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

免费注册