Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-zh
提交
99a94768
unidocs-zh
项目概览
DCloud
/
unidocs-zh
通知
3178
Star
105
Fork
805
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
93
列表
看板
标记
里程碑
合并请求
68
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
93
Issue
93
列表
看板
标记
里程碑
合并请求
68
合并请求
68
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
99a94768
编写于
2月 23, 2023
作者:
C
chenruilong
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs: update uni-id frv doc
上级
bbace6be
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
99 addition
and
19 deletion
+99
-19
docs/uniCloud/frv/dev.md
docs/uniCloud/frv/dev.md
+58
-17
docs/uniCloud/uni-id-summary.md
docs/uniCloud/uni-id-summary.md
+41
-2
未找到文件。
docs/uniCloud/frv/dev.md
浏览文件 @
99a94768
...
...
@@ -378,12 +378,12 @@ module.exports = {
-
App端使用实人认证SDK,需在隐私政策的三方SDK中添加实人认证功能描述,参考
[
详情
](
https://ask.dcloud.net.cn/article/39484#FacialRecognitionVerify
)
### 非 uniCloud 业务使用
<Badge text="uni-frv-pages
待发布" />
### 非 uniCloud 业务使用
@uni-frv-external <Badge text="uni-frv-external
待发布" />
如果您的业务没有部署在 uniCloud 上,可以通过 uni-frv-
pages
来实现实人认证功能。
uni-frv-
pages
集成了实名认证前端页面和云端云对象,适用于没有使用uniCloud或没有使用uni-id账号体系的项目。
如果您的业务没有部署在 uniCloud 上,可以通过 uni-frv-
external
来实现实人认证功能。
uni-frv-
external
集成了实名认证前端页面和云端云对象,适用于没有使用uniCloud或没有使用uni-id账号体系的项目。
插件下载地址:
[
https://ext.dcloud.net.cn/plugin?name=uni-frv-
pages
](
https://ext.dcloud.net.cn/plugin?name=uni-frv-pages
)
插件下载地址:
[
https://ext.dcloud.net.cn/plugin?name=uni-frv-
external
](
https://ext.dcloud.net.cn/plugin?name=uni-frv-external
)
#### 业务流程
...
...
@@ -415,15 +415,15 @@ sequenceDiagram
#### 项目文件说明
```
text
├── uni_modules 存放[uni_module](/uni_modules)规范的插件。
│ ├── uni-frv-
pages
│ ├── uni-frv-
external
│ │ ├── changelog.md
│ │ ├── common 页面公共逻辑
│ │ │ ├── check-id-card.js 校验身份证号合法性
│ │ │ └── common.scss
│ │ ├── components 公共组件
│ │ │ └── uni-frv-
pages
-realname 实名认证组件
│ │ │ └── uni-frv-
external
-realname 实名认证组件
│ │ │ ├── face-verify-icon.svg 实名认证错误提示Icon
│ │ │ └── uni-frv-
pages
-realname.vue
│ │ │ └── uni-frv-
external
-realname.vue
│ │ ├── package.json 包管理文件
│ │ ├── pages
│ │ │ └── common
...
...
@@ -458,9 +458,51 @@ sequenceDiagram
│ │ └── database 数据库目录
│ │ └── opendb-frv-logs.schema.json 实人认证记录表
```
#### 配置(uni-frv-co)
实人认证配置文件路径:
`uniCloud/cloudfunctions/common/uni-config-center/uni-frv-pages/config.json`
#### 开通与使用
1.
使用开发者账号登录
[
uniCloud控制台
](
https://unicloud.dcloud.net.cn/
)
,选择
`实人认证`
栏目。在使用此功能前需要完成实名认证,可前往
[
开发者中心
](
https://dev.dcloud.net.cn/
)
完成实名认证。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rpa1674035425.png
)
2.
完成实名认证后,阅读uni实名认证服务协议并点击协议下方的“同意协议并开通”按钮,便可开通实人认证服务。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rpa1674039403.png
)
3.
实人认证为预付费业务,使用实人认证服务之前,需要先进行充值。点击页面上的“充值”按钮,并输入充值金额进行充值,充值金额最小为1元。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rpa1674040001.png
)
4.
开通完成后,需要在您的业务系统中提供两个回调接口,来处理用户校验与认证结果回调通知。业务回调接口规范,
[
详见
](
#uni-frv-external-callback
)
5.
准备好回调接口后,在插件市场中导入
[
uni-frv-external
](
https://ext.dcloud.net.cn/plugin?name=uni-frv-external
)
至项目中。
6.
将回调接口配置到实人认证配置文件中,具体配置
[
详见
](
#uni-frv-co-config
)
, 实人认证配置文件路径:
`uniCloud/cloudfunctions/common/uni-config-center/uni-frv-external/config.json`
。
7.
需要自行准备一个实名认证页面,引入
`uni-frv-external-realname`
组件,组件详细配置参考
[
前端使用
](
#uni-frv-external-feuse
)
8.
在
`manifest.json`
中找到
`App模块设置-打包模块设置`
,勾选”实人认证“。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/202302231806176.png
)
9.
建议在 uniCloud 中配置服务空间白名单安全配置,可以提高接口调用安全性,防止被他人盗用。可点击“添加服务空间”按钮,选择相应的服务空间完成添加服务空间白名单,服务空间添加成功后,只有列表中的服务空间才可以调用当前账号下的实人认证接口。此列表为空时,不校验调用方的服务空间。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rap1674040168.png
)
10.
运行iOS/Android标准基座即可测试实名认证功能。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/202302231812402.png
)
11.
在用户完成实名认证后,可以在uniCloud控制台查看实人认证调用记录与统计。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rpa1674040923.png
)
但此业务数据量较大,为了维持服务的稳定性,只能查看30天内的某1天的全部调用记录,默认选择当天。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rpa1674041037.png
)
系统可查看实人认证每日调用汇总数据,包括每日请求次数、每日请求成功次数、每日计费金额等汇总数据。
#### 配置(uni-frv-co)@uni-frv-co-config
实人认证配置文件路径:
`uniCloud/cloudfunctions/common/uni-config-center/uni-frv-external/config.json`
```
json
//
如果拷贝此内容切记去除注释
...
...
@@ -477,14 +519,14 @@ sequenceDiagram
}
```
#### 前端使用
#### 前端使用
@uni-frv-external-feuse
将
`uni-frv-
pages`
插件导入至项目中,由于
`uni-frv-pages`
提供的实名认证入口是组件形式,需要自行准备实名认证页面,将
`uni-frv-pages
-realname`
引入至页面中。
将
`uni-frv-
external`
插件导入至项目中,由于
`uni-frv-external`
提供的实名认证入口是组件形式,需要自行准备实名认证页面,将
`uni-frv-external
-realname`
引入至页面中。
**组件用法**
```
vue
<uni-frv-
pages-realname
:agreement=
"{url: '', title: ''}"
token=
"user token"
@
result=
"resultCallback"
></uni-frv-pages
-realname>
<uni-frv-
external-realname
:agreement=
"{url: '', title: ''}"
token=
"user token"
@
result=
"resultCallback"
></uni-frv-external
-realname>
```
**组件Props**
...
...
@@ -520,7 +562,7 @@ Result说明
</uni-list>
</
template
>
<
template
v-else
>
<uni-frv-
pages-realname
:agreement=
"agreement"
:token=
"token"
@
result=
"resultCallback"
></uni-frv-pages
-realname>
<uni-frv-
external-realname
:agreement=
"agreement"
:token=
"token"
@
result=
"resultCallback"
></uni-frv-external
-realname>
</
template
>
</view>
</template>
...
...
@@ -552,7 +594,7 @@ Result说明
</
script
>
```
#### 业务回调接口规范
#### 业务回调接口规范
@uni-frv-external-callback
完成整个实名认证流程,需要业务服务器配合提供两个回调接口,用于用户校验与认证结果通知。
为保证请求在网络上传输安全,在请求回调地址时,
`uni-frv-co`
会对请求参数进行签名,开发者在服务器需要验证签名是否正确,不正确的签名可以将请求拒绝。
...
...
@@ -580,7 +622,7 @@ Result说明
| uni-frv-timestamp | 当前时间戳; 单位毫秒 |
| uni-frv-signature | 请求鉴权签名; 了解签名算法
[
详见
](
/uniCloud/uni-id-pages.md#http-reqeust-auth
)
|
**用户校验**
**用户校验
回调接口
**
以下示例的请求地址均为示例,在实际使用中将更换为业务服务器的回调地址。
...
...
@@ -615,8 +657,7 @@ Response Body 说明
-
开发者需要严格按照 ResponseBody 格式返回。
**认证结果通知**
**认证结果通知回调接口**
以下示例的请求地址均为示例,在实际使用中将更换为业务服务器的回调地址。
...
...
docs/uniCloud/uni-id-summary.md
浏览文件 @
99a94768
...
...
@@ -1566,7 +1566,7 @@ module.exports = {
基于
[
实人认证
](
/uniCloud/frv/intro.md
)
服务实现,可以实现用户刷脸核验真实身份,完成实名认证。
使用此功能前需要先开通实人认证服务,服务开通流程,
[
详见
](
/uniCloud/frv/service.md
)
目前仅APP端支持实名认证。
uni-id-pages 中内置了实名认证页面
`uni-id-pages/pages/userinfo/realname-verify/realname-verify`
。
...
...
@@ -1587,7 +1587,46 @@ uni-id-pages 中内置了实名认证页面`uni-id-pages/pages/userinfo/realname
1.
在
`uni-id-pages/pages/userinfo/userinfo`
页面中,注释掉实名认证的
`uni-list-item`
标签。
2.
在
`pages.json`
中注释掉实名认证页面
`uni_modules/uni-id-pages/pages/userinfo/realname-verify/realname-verify`
。
#### 配置项说明
#### 开通与使用
1.
使用开发者账号登录
[
uniCloud控制台
](
https://unicloud.dcloud.net.cn/
)
,选择
`实人认证`
栏目。在使用此功能前需要完成实名认证,可前往
[
开发者中心
](
https://dev.dcloud.net.cn/
)
完成实名认证。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rpa1674035425.png
)
2.
完成实名认证后,阅读uni实名认证服务协议并点击协议下方的“同意协议并开通”按钮,便可开通实人认证服务。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rpa1674039403.png
)
3.
实人认证为预付费业务,使用实人认证服务之前,需要先进行充值。点击页面上的“充值”按钮,并输入充值金额进行充值,充值金额最小为1元。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rpa1674040001.png
)
4.
开通完成后,在插件市场中导入
[
uni-id-pages
](
https://ext.dcloud.net.cn/plugin?id=8577
)
至项目中。
5.
参考
[
配置项说明
](
#frv-config
)
完成配置设置,详细的uni-id配置文件
[
参考
](
#config
)
。
6.
将
`uni-config-center`
与
`uni-id-co`
模块上传至云端。
7.
在
`manifest.json`
中找到
`App模块设置-打包模块设置`
,勾选”实人认证“。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/202302231806176.png
)
8.
建议在 uniCloud 中配置服务空间白名单安全配置,可以提高接口调用安全性,防止被他人盗用。可点击“添加服务空间”按钮,选择相应的服务空间完成添加服务空间白名单,服务空间添加成功后,只有列表中的服务空间才可以调用当前账号下的实人认证接口。此列表为空时,不校验调用方的服务空间。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rap1674040168.png
)
9.
运行iOS/Android标准基座即可测试实名认证功能。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/202302231812402.png
)
10.
在用户完成实名认证后,可以在uniCloud控制台查看实人认证调用记录与统计。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rpa1674040923.png
)
但此业务数据量较大,为了维持服务的稳定性,只能查看30天内的某1天的全部调用记录,默认选择当天。
![](
https://web-assets.dcloud.net.cn/unidoc/zh/rpa/rpa1674041037.png
)
系统可查看实人认证每日调用汇总数据,包括每日请求次数、每日请求成功次数、每日计费金额等汇总数据。
#### 配置项说明@frv-config
实名认证相关配置项如下,配置文件路径
`uniCloud/cloudfunctions/common/uni-config-center/uni-id/config.json`
,详细的uni-id配置文件
[
参考
](
#config
)
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录