文档

微信小程序接入

更新时间:

本文为您介绍微信小程序接入图形认证的集成方法和相关接口说明。

接入步骤

下载SDK

登录号码认证产品控制台,在概览页面右侧API&SDK区域,单击立即下载,进入API&SDK页面,根据页面提示下载并解压对应SDK。

创建认证方案

  1. 登录号码认证产品控制台

  2. 在左侧导航栏选择融合认证(基于原子能力)> 图形认证服务 > 图形认证方案管理

  3. 在图形认证方案管理页面,单击新增图形认证方案。

    输入方案名称接入端选择H5,创建图形认证方案,获取方案编码。

    说明

    接入端选择只用于标记,不影响方案号使用。

引入组件

  1. 小程序后台域名白名单添加合法域名https://captcha.alicaptcha.com

  2. 在需要验证的页面下的 xxxx.json 文件中引入要使用的组件, 示例 index.json 中:

    {  
       "usingComponents": {
        "captcha4": "/component/captcha4/captcha4"
      }
    }

  3. 在需要验证的页面下 xxxx.wxml 文件中引入要使用的组件。

    <captcha4  id="captcha" wx:if="{{loadCaptcha}}"  captchaId="{{captchaId}}" />

    参数

    是否必填

    类型

    说明

    captchaId

    string

    验证码ID,即在控制台创建认证方案后获取的方案编码。

    language

    string

    指定语言,默认值:zh。

    useNativeButton

    boolean

    是否使用唤醒按钮,取值:

    true(默认值):带按钮模式。

    false:无按钮模式(对于此类型,需要用戶主动调用showCaptcha方法唤起验证界面)。

    riskType

    string

    当服务端配置了结合风控融合,此字段可指定验证形式。

    hideBar

    array

    隐藏后续验证界面的关闭按钮、刷新按钮。可选值close/refresh。

    scale

    number

    缩放比例,默认值:1。

    mask

    object

    配置点击验证码区域外是否关闭验证,弹窗背景色。默认值:{outside:true,bgColor:’#0000004d’}

    hideSuccess

    boolean

    是否隐藏bind模式下的成功弹窗,默认值:false。

    无按钮模式下,需要手动调用验证码的showCaptcha方法,示例index.js

    const captcha = this.selectComponent('#captcha')
    captcha.showCaptcha();

事件说明

微信小程序事件通讯中固定存在一个对象event,组件返回的值位于该对象的detail属性中,以下回调参数表示detail中值。

事件名称

说明

回调参数

Success

行为验证成功时触发。

验证成功的信息。

Ready

风险初次探测完毕,验证码准备就绪时触发。

-

Close

验证码弹窗关闭时触发。

-

Error

验证码发送错误时触发。

错误信息。

Fail

验证失败时触发。

-

调用方法

方法名

说明

showCaptcha

仅当useNativeButton值为false时调用,可唤起验证码弹窗。

reset

重置验证码。

异常情况(宕机)说明

如果因为客户端网络或其他问题导致没办法访问服务器时,则进入宕机流程,宕机时验证码会直接一键通过,即时触发Success事件。