金融场景 API

1. 背景说明

在 API 列表基础上，FinClip围绕金融特色场景，提供了如下API接口供小程序使用。

需声明的是，使用以下API时，请确保宿主App已经集成对应能力且与FinClip SDK实现联调的第三方功能SDK，否则小程序调用将无法实现相关功能。

具体来说，此类场景包括：

• 如果App集成了FinClip SDK + 已与FinClip 实现联调的SDK，则此时小程序可以直接调用API，并实现相关功能目标
• 如果App仅集成了FinClip SDK、未集成与FinClip 联调成功的功能SDK，则此时小程序调用API无响应，但不会影响小程序自身业务
• 如果App集成了FinClip SDK+未与FinClip 联调的SDK，但宿主App根据API内容实现了自定义注册（iOS自定义注册API | Android自定义注册API），则小程序可调用相关API实现指定功能

综合来说，我们建议：

• 对于小程序开发者，应直接在业务代码中使用本页所述API；通过规范API调用，可最大化帮助开发者减少定制开发的工作量
• 对于宿主App，只需根据使用场景集成FinClip SDK + 其他指定功能SDK，正常情况下无需关注自定义注册API；通过本规范，宿主App可最大化减少集成、开发、联调工作量
• 对于第三方功能SDK，可与FinClip联系后，尽快参考本协议、完成双方联调，以便利其他客户接入

2. OCR卡片识别（finCardOcr）

接口名称: finCardOcr

接口依赖：无（使用任意版本FinClip SDK 均可调用）

请求参数

返回结果

recogResult字段说明

身份证正面

身份证质检

银行卡

营业执照

3. 人脸联网身份核验（finFaceAuth）

接口名称: finFaceAuth

接口依赖：无（使用任意版本FinClip SDK 均可调用）

请求参数

返回结果

4. 活体检测（finLivenessCheck）

接口名称: finLivenessCheck

接口依赖：无（使用任意版本FinClip SDK 均可调用）

请求参数

返回结果

5. 打开三方app（finOpenOtherApp）

接口名称: finOpenOtherApp

接口依赖：无（使用任意版本FinClip SDK 均可调用）

请求参数

6. 双向视频认证（finOpenWitnessVideo）

接口名称：finOpenWitnessVideo

接口依赖：无（使用任意版本FinClip SDK 均可调用）

请求参数

返回结果

7. 单向视频录制小程序实现

接口依赖：本组件无需依赖凡泰 FinClip SDK 以外的第三方 SDK

小程序单向录制组件使用

1、下载录制视频组件实例代码包

录制 demo v1.0.0 (opens new window)

组件代码在根目录的 components 内，也可直接用 ide 工具打开录制 demo 查看效果

2、在需要使用的页面或组件的 json 文件内，引入录制组件

{
  "usingComponents": {
    "video-recognition": "../../components/video-recognition/index"
  }
}

3、在页面或组件的 wxml 内，使用组件

<view style="width: 100vw;height: 100vh;">
  <video-recognition recordTime="{{recordTime}}"
                     top="{{top}}"
                     stepList="{{stepList}}"
                     buttonStyle="{{buttonStyle}}"
                     mask="../../assets/img_mask_person@3x.png"
                     resolution="low"
                     bind:onRecordReady="onRecordReady"
                     bind:onRecordStart="onRecordStart"
                     bind:onRecordEnd="onRecordEnd"
                     bind:onRecordError="onRecordError">
  </video-recognition>
</view>

注意

录制组件外层需要声明宽高尺寸，录制组件内会按 width: 100%; height: 100% 展示

4、组件参数一览

stepList 参数说明

每⼀步的语⾳和提示⽂案配置，最大支持长度为 3

数据元素结构如下：

{
  "audioSrc": "https://xxxxx.mp3",
  "showTime": 0,
  "textList": []
}

audioSrc - 音频链接，建议使用 https 链接，组件 attached 会下载音频资源，若下载失败会执行 error 回调，报资源加错错误

注意

mp3 的域名需在管理后台添加到白名单内，否则会下载失败

showTime - 文本提示和音频的展示时间，毫秒数，0 表示初始展示，2000 表示录制开始 2s 时展示

textList - 文本提示，数组类型

textList 参数对象如下：

{
  "text": '请用普通话大声朗读'
}

text - 文本内容

可添加 width|height|padding|margin|color|fontSize|fontWeight|textAlign 等样式属性简单控制文本样式：

{
  "text": '文本',
  "color": 'red',
  "fontWeight": 'bold',
  "margin": '0 20rpx'
}

注意

一个 textList 子元素，展示时会以单行不换行展示，可按需拆分成多行多个子元素

另外，如果单行内容内需要个别词语高亮展示，text 属性可以传入数组，属性与上述对象参数一致，如下：

{
  "text": [{
    "text": '文本'
  }, {
    "text": '高亮文本',
    "color": 'red',
    "fontWeight": 'bold',
    "margin": '0 20rpx'
  }, {
    "text": '文本'
  }]
}

stepList 只在初始化时有效，不能动态变更

本组件使用小程序原生语法开发，除文档描述的参数外，也可自行修改组件内的逻辑，满足不同的业务需求。