>

概述及资源

极验支付宝小程序插件需要先完成服务端部署。本文主要描述极验小程序插件的使用流程,文档中的接入demo可在 GitHub上获取 (demo地址)。

支付宝插件使用文档

环境要求

条目
开发工具 支付宝开发者工具
调试基础库v1.x 最低支持1.25.1
调试基础库v2.x 最低支持2.7.2

安装

准备工作

服务端部署完成(服务端部署文档)

插件申请

在使用插件前,首先要在小程序管理后台的“开发-插件服务-添加插件”或支付宝插件市场中搜索id 2021002178617823极验行为验插件 查找并添加验证码插件,等待极验通过申请即可使用。

插件包引入

页面中使用插件前,需要先在项目app.json中声明所需要使用的插件。

代码示例:

{
"plugins": {
"captcha4": {
"version": "*", // 目前只支持设置 * 拉取当前上架最新版本
"provider": "2021002178617823"
}
}
}

使用插件

使用插件的方法和普通自定义组件相仿。在页面 .json 文件定义需要引入的自定义组件时,使用 plugin:// 协议指明插件的引用名和自定义组件名。

代码示例:

{
"usingComponents": {
"captcha4": "plugin://captcha4/captcha4"
}
}

模板插入

axml中插入captcha4模板,示例中的参数为必传参数,其它拓展参数参考api文档。

代码示例:

<captcha4 id="captcha" a:if="{{loadCaptcha}}" captchaId="{{captchaId}}"  onSuccess="captchaSuccess"/>

初始化

在需要渲染插件的时候,使用setData 传入必须的参数进行初始化。

代码示例:

onLoad: function() {
this.setData({ loadCaptcha:true,captchaId:'wxxxxxxxxxxxx'})
}

获取成功凭证

成功完成验证码后,会触发用户自定义的captchaSuccess 函数,将验证结果存储在result(这里用户可自定义),等待二次验证时提取上传,无按钮模式时可以直接在此处进行二次验证。

代码示例:

captchaSuccess:function(result){
console.log("captcha-Success!");
this.setData({
result: result.detail
})
}

二次验证

用户点击提交按钮触发提交,进行二次验证。

代码示例:

captchaValidate: function(){
var self = this;
var data = self.data.result; // 获取完成验证码时存储的验证结果
if(typeof data !== 'object'){
console.log("请先完成验证!")
return
}
// 将结果提交给用户服务端进行二次验证
my.request({
url: "API2接口(详见服务端部署)",
method: 'POST',
dataType: 'json',
data: Object.assign({},data, {
captcha_id: self.data.captchaId
}),
success: function (res) {
my.showToast({
title: res.data.result
})
},
fail: function () {
console.log('error')
}
})
}

配置参数

这里说的配置参数,是指初始化时调用setData时,传入的值。

以下为必需配置的参数,建议按照上述示例代码方式填写

参数 类型 说明
captchaId 字符串 验证 id,极验后台申请得到

以上是必需配置的参数,可选配置参数参考 MiniProgram API 的参数配置

体验demo