提交 d05dd798 编写于 作者: DCloud-yyl's avatar DCloud-yyl

调整实人认证API文档

上级 c1324532
### 实人认证
### uni.startFacialRecognitionVerify(OBJECT)
实人认证
uni.startFacialRecognitionVerify是客户端API,App端使用实人认证功能需调用云端API获取certifyId,详情参考[开发指南](https://uniapp.dcloud.net.cn/uniCloud/frv/dev.html)
**平台差异说明**
......@@ -6,33 +9,34 @@
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|√(3.7.1+)|x|x|x|x|x|x|x|x|
### 语法
`uni.startFacialRecognitionVerify(options)`
**注意**
* 需HBuilderX3.7.1+,App端需在“App模块配置”中勾选“FacialRecognitionVerify(实人认证)”
* App-Android平台要求Android5(API Leavel 21)及以上系统
* App-iOS平台要求iOS10及以上系统
* 微信小程序端请参考[微信人脸核身接口能力](https://developers.weixin.qq.com/community/business/doc/000442d352c1202bd498ecb105c00d)
### 参数说明
#### OBJECT参数说明
| 参数 | 类型 | 是否必传 | 支持平台 |描述 |
|---|---|---|---|---|
| certifyId | String | 是 | 安卓、iOS |认证流水号,由服务端根据接入的业务模式调用对应的初始化接口获取 |
| progressBarColor | String | 否 | 安卓、iOS | 刷脸圈的颜色 |
| activityIndicatorColor | String | 否 | iOS | 网络等待菊花颜色 |
| progressBarBackgroundColor | String | 否 | 安卓 | 刷脸圈的背景颜色 |
| quitAlertTitle | String | 否 | 安卓 | 刷脸页退出对话框的标题 |
| quitAlertMessage | String | 否 | 安卓 | 刷脸页退出对话框的内容 |
| timeoutAlertTitle | String | 否 | 安卓 | 刷脸页超时对话框的标题 |
| timeoutAlertMessage | String | 否 | 安卓 | 刷脸页超时对话框的内容 |
| failAlertTitle | String | 否 | 安卓 | 刷脸页错误提示对话框的标题 |
| failAlertMessage | String | 否 | 安卓 | 刷脸页错误提示对话框的内容 |
| title | String | 否 | 安卓 | 刷脸圈的颜色 |
| success | String | 否 | 安卓、iOS | 成功回调 |
| fail | String | 否 | 安卓、iOS | 失败回调 |
| complete | String | 否 | 安卓、iOS | 完成回调 |
注: 颜色值为六位十六进制字符串("#FF0000")
### 返回值
| certifyId | String | 是 | App |认证流水号,由服务端根据接入的业务模式调用对应的初始化接口获取 |
| progressBarColor | String | 否 | App | 刷脸圈的颜色 |
| activityIndicatorColor | String | 否 | App-iOS | 网络等待菊花颜色 |
| progressBarBackgroundColor | String | 否 | App-Android | 刷脸圈的背景颜色 |
| quitAlertTitle | String | 否 | App-Android | 刷脸页退出对话框的标题 |
| quitAlertMessage | String | 否 | App-Android | 刷脸页退出对话框的内容 |
| timeoutAlertTitle | String | 否 | App-Android | 刷脸页超时对话框的标题 |
| timeoutAlertMessage | String | 否 | App-Android | 刷脸页超时对话框的内容 |
| failAlertTitle | String | 否 | App-Android | 刷脸页错误提示对话框的标题 |
| failAlertMessage | String | 否 | App-Android | 刷脸页错误提示对话框的内容 |
| title | String | 否 | App-Android | 刷脸圈的颜色 |
| success | Function | 否 | App | 成功回调 |
| fail | Function | 否 | App | 失败回调 |
| complete | Function | 否 | App | 完成回调 |
注意: 颜色字符串格式为“#RRGGBB”,RRGGBB为十六进制字符串,如红色("#FF0000")
#### CALLBACK返回值
|参数|描述|
|---|---|
......@@ -41,14 +45,14 @@
|errMsg|错误信息(详情见下表)|
|cause|SDK返回的原始数据 (certifyId不为空时返回)|
#### cause
#### cause
|参数|描述|
|---|---|
|code | 原始错误码|
|message|原始错误信息|
### 错误码
#### 错误码
|错误码|信息|描述|
|---|---|---|
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册