> >

概述与资源

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

OneLogin API 小程序

安装

准备工作: 服务端部署完成(服务端部署文档

1、获取资源

用户根据接入小程序类型下载对应JS,目前Onelogin 一键登录小程序支持 微信小程序

注意: 个人类型的小程序一键登录暂不支持使用

资源下载

2、 引用一键登录小程序自定义组件

在需要使用一键登录页面目录中 .json 文件中引入自定义组件

{
"usingComponents": {
"gt-onelogin": "/component/自定义组件路径/gt-onelogin" // 注意项目的工程目录填入正确的引入的路径
}
}

3、 在.wxml 文件中使用组件

<gt-onelogin class="gt-onelogin-container"/>

4、 在.ts 文件中调用组件

const child = this.selectComponent('.gt-onelogin-container')
child.getPreWay({
data: {
app_id: 'appid',// 您在极验后台申请的appID
authPage: 'customer', // 自定义授权页面
agreement_page: '../test/index', // 用于授权页面隐私条款,方便用户进入隐私条款后返回。路径为项目创建的隐私条款落地页面,详情参考5.创建隐私条款落地页面
logo: 'https://**.png'// logo路径 确保logo路径正常能在浏览器中访问到
},
success: function (params: any) {
wx.request({
url: '您API地址', // 您的服务端校验接口
data: { app_id:'appid', ...params },
method: 'POST',
timeout: 30000,
success: function () {
// 成功 跳转到success页面 可根据需求跳转
wx.redirectTo({
url: '/pages/success/index?ol=true',// 这个是模拟跳转 接入方可根据需求进行处理
})
},
fail: function () {
// 切换到降级模式 短信+验证码
// 接入方可根据需求进行处理
wx.navigateTo({
url: '/pages/**', // 模拟跳转 接入方可根据需求进行处理
})
wx.showToast({title: '验证失败',icon: 'none' , duration: 2000})
}
},
)
},
fail: function (params: any) {
// 失败提示并且走降级
wx.showToast({title: '验证失败',icon: 'none' , duration: 2000})
// 切换到降级模式 短信+验证码
// 接入方可根据需求进行处理
wx.navigateTo({
url: '/pages/**', // 模拟跳转 接入方可根据需求进行处理
})
}
})

5、 创建隐私条款落地页面

例: 在路径page/test 下创建隐私条款落地页面

wxml 文件

<web-view src="{{url}}" wx:if="url"></web-view>

js 文件

Page({
data: {
url: ''
},
onLoad: function (params) {
this.setData({url: params.url})
}
})

6、前往小程序后台添加request合法域名和业务域名

配置列表

合法域名和业务域名配置参数

注意:业务域名添加前可以联系客服确保校验文件已报备

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

7、返回码

返回码

OnePass API 小程序

安装

准备工作: 服务端部署完成(服务端部署文档

1、获取资源

用户根据接入小程序类型下载对应JS,目前OnePass API小程序支持 微信小程序、字节小程序、快手小程序

资源下载

2、资源引用

// 在使用onepass API 页面JS中 引入JS资源文件 注意引入路径
const Onepass = require('路径地址/**.js')

3、初始化onepass对象

说明: 在初始化onepass前可调用小程序 获取设备当前所处的网络类型方法进行网络判断后,判断是否提前获运营商参数 pre_init; 该方法可提升非纯4G网络环境下用户的使用体验,为可选方法,不使用该方法不影响正常接入使用

// 以下以微信小程序为例, 不同小程序获取网络判断不一样
// 快手小程序为:ks.getNetworkType()
// 字节小程序为:tt.getNetworkType()
const that = this
wx.getNetworkType({
success (res) {
let is_pre = false;
if(res.networkType!== 'wifi' && res.networkType !== 'none'){
is_pre = true;
}else {
//可以提示用户'请关闭WIFI,打开数据流量进行体验'。开发者可自定义;
}
// 初始化onepass对象 注意此处this指向
that.opInstance = new Onepass({
app_id: '您申请的ID',
timeout: 3000,// 超时时间
pre_init: is_pre // 是否初始化时获取运营商参数;默认为true
})
}
})

4、调用网关接口 gateway

this.opInstance.gateway('phone', function(err, url){
if(!err){
// 网关调用成功,获取accesscode后调用服务端接口(您服务端接口),校验是否成功
} else {
// 失败,调用短信 降级处理
}
})

5、前往小程序后台添加request合法域名

配置列表

Request 合法域名配置参数

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

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

6、返回码

返回码