Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
qq_16800119
unidocs-zh
提交
b60178ae
unidocs-zh
项目概览
qq_16800119
/
unidocs-zh
与 Fork 源项目一致
Fork自
DCloud / unidocs-zh
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
b60178ae
编写于
2月 10, 2023
作者:
DCloud-yyl
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
调整实人认证文档
上级
8cf4274b
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
80 addition
and
153 deletion
+80
-153
docs/api/plugins/facialRecognitionVerify.md
docs/api/plugins/facialRecognitionVerify.md
+8
-59
docs/tutorial/app-facialRecognitionVerify.md
docs/tutorial/app-facialRecognitionVerify.md
+9
-53
docs/uniCloud/frv/dev.md
docs/uniCloud/frv/dev.md
+63
-41
未找到文件。
docs/api/plugins/facialRecognitionVerify.md
浏览文件 @
b60178ae
### uni.startFacialRecognitionVerify(OBJECT)
### uni.startFacialRecognitionVerify(OBJECT)
实人认证
实人认证
uni.startFacialRecognitionVerify是客户端API,
App端使用实人认证功能需调用云端API获取certifyId,参考
[
开发指南
](
https://uniapp.dcloud.net.cn/uniCloud/frv/dev.html
)
uni.startFacialRecognitionVerify是客户端API,
在App端打开刷脸认证界面。
**平台差异说明**
App端API规范参考:
[
详情
](
https://uniapp.dcloud.net.cn/uniCloud/frv/dev.html#start-frv
)
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
App平台完整业务开发流程,参考
[
开发指南
](
https://uniapp.dcloud.net.cn/uniCloud/frv/dev.html
)
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
微信小程序端业务开发流程,请参考
[
微信人脸核身接口能力
](
https://developers.weixin.qq.com/community/business/doc/000442d352c1202bd498ecb105c00d
)
|√(3.7.1+)|x|x|x|x|x|x|x|x|
**注意**
*
HBuilderX3.7.1+新增支持,App端需在“App模块配置”中勾选“FacialRecognitionVerify(实人认证)”
*
App端使用蚂蚁金服人脸认证SDK,需在隐私政策的三方SDK中添加实人认证功能描述,参考
[
详情
](
https://ask.dcloud.net.cn/article/39484#FacialRecognitionVerify
)
*
App-Android平台要求Android5(API Leavel 21)及以上系统
*
App-iOS平台要求iOS10及以上系统
*
微信小程序端请参考
[
微信人脸核身接口能力
](
https://developers.weixin.qq.com/community/business/doc/000442d352c1202bd498ecb105c00d
)
#### OBJECT参数说明
| 参数 | 类型 | 是否必传 | 支持平台 |描述 |
|---|---|---|---|---|
| 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返回值
**平台说明**
|参数|描述|
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|---|---|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|errSubject | 模块名称(uni-facialRecognitionVerify)|
|√(3.7.2+)|x|√|x|x|x|x|x|x|
|errCode|错误码(详情见下表)|
|errMsg|错误信息(详情见下表)|
|cause|SDK返回的原始数据 (certifyId不为空时返回)|
#### cause
|参数|描述|
|---|---|
|code | 原始错误码|
|message|原始错误信息|
#### 错误码
|错误码|信息|描述|
|---|---|---|
|0|刷脸完成|实际结果需要通过服务端查询接口|
|10001|certifyId 不能为空 |参数 certifyId 为空|
|10010| 刷脸异常|刷脸异常,具体原因详见cause|
|10011|验证中断 |如用户主动退出、验证超时等,具体原因详见cause|
|10012|网络异常 |网络异常 |
|10013|刷脸验证失败 |实际结果需要通过服务端查询结果|
|10020|设备设置时间异常 |设备设置时间异常,仅iOS返回|
docs/tutorial/app-facialRecognitionVerify.md
浏览文件 @
b60178ae
使用实人认证功能需要在项目manifest.json的"App模块配置"中勾选"FacialRecognitionVerify(实人认证)"
## 实人认证
![](
https://native-res.dcloud.net.cn/images/uniapp/facialRecognitionVerify/68C3B72D-E281-4ED3-9B34-91AE9BB1B9F6.png
)
### 开通服务
App使用实人认证功能需先开通uni实人认证服务,详情参考:
[
开通uni实人认证服务
](
https://uniapp.dcloud.net.cn/uniCloud/frv/service.html
)
## 调起实人认证
```
js
uni
.
startFacialRecognitionVerify
(
Object
params
)
```
**params参数说明**
| 参数 | 类型 | 是否必传 | 支持平台 |描述 |
|--- |--- |--- |--- |--- |
| 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 | 完成回调 |
**注意**
HBuilderX3.7.1+新增支持,Android平台要求Android5(API Leavel 21)及以上系统,iOS平台要求iOS10及以上系统
颜色字符串格式为“#RRGGBB”,RRGGBB为十六进制字符串,如红色("#FF0000")
获取certifyId参考
[
开发指南
](
https://uniapp.dcloud.net.cn/uniCloud/frv/dev.html
)
详细API参考
[
实人认证API
](
https://uniapp.dcloud.net.cn/api/plugins/facialRecognitionVerify.html#startfacialrecognitionverify
)
## 设置自定义UI资源(仅iOS)
iOS不支持通过参数的方式修改刷脸页的提示文案,但可以通过自定义bundle文件的方式修改提示内容以及国际化信息
[
APBToygerFacade.bundle文件下载
](
https://native-res.dcloud.net.cn/uni-app/file/APBToygerFacade.zip
)
首先需要下载APBToygerFacade.bundle文件,可通过修改APBToygerFacade.bundle中的内容自定义多语言文案,如 zh-Hans.strings 代表中文文案,en.strings 代表英文文案,内容格式为 "APBToygerFacade:xxxA"="xxxB",xxxA 为目标修改文案,xxxB 为修改后的文案,示例内容如下:
```
"APBToygerFacade:xxxA"="xxxB";
"APBToygerFacade:当前设备不支持刷脸"="当前设备不支持刷脸";
"APBToygerFacade:拿起手机眨眨眼"="拿起手机,眨眨眼";
"APBToygerFacade:再试一次"="再试一次";
"APBToygerFacade:无法启动相机"="无法打开相机";
"APBToygerFacade:网络不给力"="网络异常";
```
此处文案修改后需要完整测试回归 UI 以及文案变化影响,以免影响用户体验。修改后的bundle文件配到项目根目录的 nativeResources -> ios -> Resources 路径下后打包即可,详情参照
[
iOS原生应用配置文件和资源
](
https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-ios.html
)
### 配置
在项目manifest.json的"App模块配置"中勾选"FacialRecognitionVerify(实人认证)"
![](
https://native-res.dcloud.net.cn/images/uniapp/facialRecognitionVerify/68C3B72D-E281-4ED3-9B34-91AE9BB1B9F6.png
)
### 使用
App端API规范参考:
[
详情
](
https://uniapp.dcloud.net.cn/uniCloud/frv/dev.html#start-frv
)
App平台完整业务开发流程,参考
[
开发指南
](
https://uniapp.dcloud.net.cn/uniCloud/frv/dev.html
)
docs/uniCloud/frv/dev.md
浏览文件 @
b60178ae
...
@@ -249,12 +249,18 @@ module.exports = {
...
@@ -249,12 +249,18 @@ module.exports = {
#### 调起实人认证界面@start-frv
#### 调起实人认证界面@start-frv
**接口形式**
通过云函数获取certifyId后,在客户端调用
[
uni.startFacialRecognitionVerify
](
https://uniapp.dcloud.net.cn/api/plugins/facialRecognitionVerify.html
)
打开认证界面,通过刷脸操作获取认证结果。
```
js
`uni.startFacialRecognitionVerify(OBJECT)`
uni
.
startFacialRecognitionVerify
(
Object
StartFacialRecognitionVerifyParam
)
```
**注意**
*
HBuilderX3.7.2+新增支持
*
App端需在“App模块配置”中勾选“FacialRecognitionVerify(实人认证)”,参考
[
详情
](
https://uniapp.dcloud.net.cn/tutorial/app-facialRecognitionVerify.html
)
*
App端使用蚂蚁金服人脸认证SDK,需在隐私政策的三方SDK中添加实人认证功能描述,参考
[
详情
](
https://ask.dcloud.net.cn/article/39484#FacialRecognitionVerify
)
*
App-Android平台要求Android5(API Leavel 21)及以上系统
*
App-iOS平台要求iOS10及以上系统
**示例**
```
js
```
js
uni
.
startFacialRecognitionVerify
({
uni
.
startFacialRecognitionVerify
({
certifyId
:
""
,
certifyId
:
""
,
...
@@ -279,43 +285,59 @@ uni.startFacialRecognitionVerify({
...
@@ -279,43 +285,59 @@ uni.startFacialRecognitionVerify({
})
})
```
```
**参数说明**
##### OBJECT参数说明
| 参数 | 类型 | 是否必传 | 支持平台 |描述 |
| 参数 | 类型 | 是否必传 | 支持平台 | 描述 |
|--- |--- |--- |--- |--- |
| --- | --- | --- | --- | --- |
| certifyId | String| 是 | 安卓、iOS |认证流水号,由服务端根据接入的业务模式调用对应的初始化接口获取 |
| certifyId | String | 是 | App | 认证流水号,由服务端根据接入的业务模式调用对应的初始化接口获取 |
| progressBarColor | String| 否 | 安卓、iOS | 刷脸圈的颜色 |
| progressBarColor | String | 否 | App | 刷脸圈的颜色 |
| activityIndicatorColor | String| 否 | iOS | 网络等待菊花颜色 |
| activityIndicatorColor | String | 否 | App-iOS | 网络等待菊花颜色 |
| progressBarBackgroundColor| String| 否 | 安卓 | 刷脸圈的背景颜色 |
| progressBarBackgroundColor| String | 否 | App-Android | 刷脸圈的背景颜色 |
| quitAlertTitle | String| 否 | 安卓 | 刷脸页退出对话框的标题 |
| quitAlertTitle | String | 否 | App-Android | 刷脸页退出对话框的标题 |
| quitAlertMessage | String| 否 | 安卓 | 刷脸页退出对话框的内容 |
| quitAlertMessage | String | 否 | App-Android | 刷脸页退出对话框的内容 |
| timeoutAlertTitle | String| 否 | 安卓 | 刷脸页超时对话框的标题 |
| timeoutAlertTitle | String | 否 | App-Android | 刷脸页超时对话框的标题 |
| timeoutAlertMessage | String| 否 | 安卓 | 刷脸页超时对话框的内容 |
| timeoutAlertMessage | String | 否 | App-Android | 刷脸页超时对话框的内容 |
| failAlertTitle | String| 否 | 安卓 | 刷脸页错误提示对话框的标题 |
| failAlertTitle | String | 否 | App-Android | 刷脸页错误提示对话框的标题 |
| failAlertMessage | String| 否 | 安卓 | 刷脸页错误提示对话框的内容 |
| failAlertMessage | String | 否 | App-Android | 刷脸页错误提示对话框的内容 |
| title | String| 否 | 安卓 | 刷脸圈的颜色 |
| title | String | 否 | App-Android | 刷脸圈的标题 |
| success | String| 否 | 安卓、iOS | 成功回调 |
| success | Function | 否 | App | 成功回调 |
| fail | String| 否 | 安卓、iOS | 失败回调 |
| fail | Function | 否 | App | 失败回调 |
| complete | String| 否 | 安卓、iOS | 完成回调 |
| complete | Function | 否 | App | 完成回调 |
注: 颜色字符串格式为“#RRGGBB”,RRGGBB为十六进制字符串,如红色("#FF0000")
注: 颜色值为六位十六进制字符串("#FF0000")
##### CALLBACK返回值
**返回值**
| 参数 | 描述 |
|参数 |类型 |必备 |描述 |
| --- | --- |
|--- |--- |--- |--- |
| errSubject | 模块名称(uni-facialRecognitionVerify) |
|errSubject |String |是 | 模块名称(uni-facialRecognitionVerify) |
| errCode | 错误码,详情见:
[
错误码
](
#err-code
)
|
|errCode |Number |是 |错误码,详情见:
[
错误码
](
#err-code
)
|
| errMsg | 错误信息,详情见:
[
错误码
](
#err-code
)
|
|errMsg |String |否 |错误信息,详情见:
[
错误码
](
#err-code
)
|
| cause | SDK返回的原始数据 (certifyId不为空时返回) |
|cause |Object |否 |SDK返回的原始数据 |
##### cause
cause
| 参数 | 描述 |
| --- | --- |
| code | SDK原始错误码 |
| message | SDK原始错误信息 |
#### iOS平台自定义UI
iOS平台不支持通过参数的方式修改刷脸页的提示文案,但可以通过自定义bundle文件的方式修改提示内容以及国际化信息
[
APBToygerFacade.bundle文件下载
](
https://native-res.dcloud.net.cn/uni-app/file/APBToygerFacade.zip
)
首先需要下载APBToygerFacade.bundle文件,可通过修改APBToygerFacade.bundle中的内容自定义多语言文案,如 zh-Hans.strings 代表中文文案,en.strings 代表英文文案,内容格式为 "APBToygerFacade:xxxA"="xxxB",xxxA 为目标修改文案,xxxB 为修改后的文案,示例内容如下:
```
"APBToygerFacade:xxxA"="xxxB";
"APBToygerFacade:当前设备不支持刷脸"="当前设备不支持刷脸";
"APBToygerFacade:拿起手机眨眨眼"="拿起手机,眨眨眼";
"APBToygerFacade:再试一次"="再试一次";
"APBToygerFacade:无法启动相机"="无法打开相机";
"APBToygerFacade:网络不给力"="网络异常";
```
|参数 |描述 |
此处文案修改后需要完整测试回归 UI 以及文案变化影响,以免影响用户体验。修改后的bundle文件配到项目根目录的 nativeResources -> ios -> Resources 路径下后打包即可,详情参照
[
iOS原生应用配置文件和资源
](
https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-ios.html
)
|--- |--- |
|code |原始错误码 |
|message|原始错误信息 |
### 错误码@err-code
### 错误码@err-code
...
@@ -354,7 +376,7 @@ cause
...
@@ -354,7 +376,7 @@ cause
**注意**
**注意**
-
为对抗攻击,
蚂蚁实人认证
返回的错误原因比较模糊。
-
为对抗攻击,
实人认证SDK
返回的错误原因比较模糊。
### 发行打包
### 发行打包
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录