文档中心 人脸核身 接入文档 微信小程序接入

微信小程序接入

最近更新时间:2019-06-19 18:46:30

小程序在微信使用场景中越来越广泛,腾讯云人脸核身针对小程序提供嵌入式 SDK,开发人员可以将相应的 SDK 添加到小程序开发工具中,从而直接调用小程序 SDK 中提供的 OCR 识别、活体检测和 1:1人脸比对服务。

微信小程序提供两种活体模式(读数字、光线),都是基于微信原生的体验,要求符合以下行业要求的客户才能 申请服务,经微信侧审核通过后,即可对接。

政务:政府机构或事业单位

金融:银行、保险

医疗:公立医疗机构

运营商:电信运营商

教育:公立教育机构

交通:航空、客运、网约车、交通卡、共享交通、轨道交通、租车

旅游:酒店

物流:快递、邮政、物流

图片

接入流程

  1. 客户需要后端调用 DetectAuth 接口进行核身流程开启前鉴权,获取业务流水号(BizToken)与微信跳转 URL。
  2. 根据客户自身需求,按照不同的方式跳转进入腾讯云人脸核身流程。
    例如通过小程序 SDK 接入:客户后端将 BizToken 返回给客户小程序端,然后按照小程序 SDK 接入文档接入即可。
  3. 人脸核身完成后,流程会回调至客户侧(HTML5类型以回调地址形式返回、SDK 类型以回调函数形式返回),客户后端可凭借回调中提供的 BizToken 调用 GetDetectInfo 接口获取本次核身的详细信息。

SDK 接入

开发准备

下载 SDK

本 SDK 暂不支持通过外部 npm 源下载,线下对接时,腾讯云侧会提供 SDK(包名为verify_mpsdk)。

安装 SDK

将小程序 SDK 文件夹放在小程序根目录下,使用 require 函数引入。

const Verify = require('/verify_mpsdk/main');

卸载 SDK

卸载时删除verify_mpsdk文件夹,移除相应 require 代码即可。

快速入门

  1. 将 verify_mpsdk 文件夹放到小程序项目根目录。
  2. 初始化慧眼实名核身 SDK。
    在 app.js 的 onLaunch() 中加入相应代码,在 app.json 文件里添加活体验证页面verify_mpsdk/index/index
    //app.js
    App({
     onLaunch: function () {
         // 初始化慧眼实名核身组件
         const Verify = require('/verify_mpsdk/main');
         Verify.init();
     }
    }) 
    // app.json
    {
     "pages":[
         "verify_mpsdk/index/index"
     ]
    }
  3. 调用 SDK 功能函数 wx.startVerify()。
    在需要实名认证的地方调用 wx.startVerify() 进入实名认证页面,认证完成会触发对应的回调函数。
    // 单击某个按钮时,触发该函数
    gotoVerify: function () {
     let BizToken = getBizToken();// 去客户后端调用DetectAuth接口获取BizToken
     // 调用实名核身功能
     wx.startVerify({
         data: {
             token: BizToken // BizToken
         },
         success: (res) => { // 验证成功后触发
             // res 包含验证成功的token, 这里需要加500ms延时,防止iOS下不执行后面的逻辑
             setTimeout(() => {
                 // 验证成功后,拿到token后的逻辑处理,具体以客户自身逻辑为准
             }, 500);
         },
         fail: (err) => {  // 验证失败时触发
             // err 包含错误码,错误信息,弹窗提示错误
             setTimeout(() => {
                 wx.showModal({
                     title: "提示",
                     content: err.ErrorMsg,
                     showCancel: false
                 })
             }, 500);
         }
     });
    }
  4. 添加域名服务器白名单。
    小程序前端接口请求有域名白名单限制,未添加白名单的域名只能在调试模式下运行。您需要在小程序上线前需要将以下两个域名添加至白名单:
    // request 合法域名、uploadFile 合法域名、downloadFile 合法域名这三种都要添加
    faceid.qq.com、btrace.qq.com

基本 API 描述

  • Verify.init(options):初始化插件。
    • options:Obejct required 初始化的参数。
    • options.env:String required 接口环境。正式环境为 release,开发环境为 dev。
  • wx.startVerify(options):进入实名认证页面。
    • options:Object required 初始化的参数。
    • options.data.token:String required 客户后端调用 DetectAuth 接口获取的 BizToken。
    • options.success:Function(res) required 验证成功的回调。res 包含验证成功的 token。
    • options.fail:Function(err) required 验证失败的回调。err 包含错误码、错误信息。