提交 1010714a 编写于 作者: VK1688's avatar VK1688

新增手机号三要素认证简版和详版

上级 f9703840
# 开发指南
## 添加 uni-cloud-verify 扩展库依赖
在需要调用此API的云函数或云对象右键,添加依赖
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/c57bf00f-3c0e-4e5f-b979-996e7de20887.png)
勾选 uni-cloud-verify 扩展库依赖
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/665b7307-7506-42ad-ad3f-6c7c1d59569f.png)
## API@api
### 响应公共字段@publicreturn
|字段 |类型 |说明 |
|:-: |:-: |:- |
|errCode|Number |为0代表请求成功,其他均为请求失败,注意,请求成功不代表验证通过 |
|errMsg |String |请求失败的错误描述 |
|data |Object | 请求成功时,服务端返回的数据 |
### 获取uni认证管理对象@getuniverifymanager
云端在操作前,需要先获取 uniVerifyManager 对象实例,然后再通过 uniVerifyManager.xxx 调用对应的API
**云端代码**
```js
const uniVerifyManager = uniCloud.getUniVerifyManager({
provider: "univerify"
});
```
**请求参数**
|参数名 |类型 |必填 |默认值 |说明 |
|:-: |:-: |:-: |:-: |:- |
|provider |String |是 |- |必填,当前固定填写 univerify 即可 |
### 获取手机号三要素认证结果@mobile3metaverify
接口名:mobile3MetaVerifyPro
你可以在调用 extStorageManager.mobile3MetaVerify 前执行一些自己的业务逻辑,判断用户是否有权限执行此API等等
**云端代码**
```js
const uniVerifyManager = uniCloud.getUniVerifyManager({
provider: "univerify"
});
let verifyRes = await uniVerifyManager.mobile3MetaVerifyPro({
realName: "姓名",
idCard: "身份证",
mobile: "手机号",
});
console.log('认证结果: ', verifyRes.data);
```
**请求参数**
|参数名 |类型 |必填 |默认值 |说明 |
|:- |:-: |:-: |:-: |:- |
|realName |String |是 |- |姓名 |
|idCard |String |是 |- |身份证 |
|mobile |String |是 |- |手机号 |
**响应参数**
响应字段如下,响应通用字段已省略,详细见[响应公共字段](#publicreturn)
|名称 |类型 |必须返回 |描述 |
|:- |:-: |:-: |:- |
|status |Number |是 |认证结果,1-通过 2-不通过 3-查无结果 0-待定 |
|reasonType |Number |否 |原因详情:<br/>2-认证不一致 <br/>3-该手机号查询无记录 <br/>4-认证信息有误 <br/>5-号码状态异常(空号、停机等)<br/>6-解析手机号运营商失败<br/>7-其他出错<br/>以下返回为详版专属<br/>20-手机号已实名,姓名正确,但证件号错误<br/>21-手机号已实名,证件号正确,但姓名错误<br/>22-手机号已实名,但证件号和姓名均非该手机号绑定信息 |
|taskId |String |是 |本次请求数据标识,可以根据该标识查询数据最新结果 |
|isPayed |Number |是 |本次请求是否收费标识,1代表收费,0代表不收费 |
|mobileType |String |是 |运营商类型:1-移动,2-联通,3- 电信,9,-未知 |
**响应体示例**
```json
{
"errCode": 0,
"errMsg": "",
"success": true,
"data": {
"status": 1,
"reasonType": 1,
"taskId": "9f9def8638c74506b3f5ef17f893c8b9",
"isPayed": 1,
"mobileType": "3",
"note": ""
}
}
```
\ No newline at end of file
## 费用说明
接口名称:手机号三要素认证-详版
### 资源包价格
|规格(次数) |价格(元) | 单价(元) |
|-- |-- |-- |
|20(限购1个) |5 |0.25 |
|100 |34 |0.34 |
|200 |66 |0.33 |
|500 |160 |0.32 |
|1000 |310 |0.31 |
|2000 |600 |0.3 |
|5000 |1450 |0.29 |
|10000 |2800 |0.28 |
|20000 |5400 |0.27 |
|50000 |13000 |0.26 |
|100000 |25000 |0.25 |
## 业务开通
### 开通流程
使用开发者账号登录[uniCloud控制台](https://unicloud.dcloud.net.cn/) ,选择`核验服务`栏目。在使用此功能前需要完成实名认证,可前往[开发者中心](https://dev.dcloud.net.cn/pages/user/info)完成实名认证。
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/49854ade-daa0-4865-a8c0-37ce54e0aaa5.png)
点击进入后会自动开通对应业务
### 购买资源包
【手机号三要素认证-简版】为预付费业务,使用之前,需要先进行购买资源包。点击页面上的“购买资源包”按钮,购买相应的资源包(目前只支持资源包的付费方式)
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/dbc18eac-6f8e-4efb-a8d7-939ec2eafc82.png)
### 安全配置
系统提供了 uniCloud 服务空间白名单安全配置,可以提高接口调用安全性,防止被他人盗用。可点击“添加”按钮,选择相应的服务空间完成添加服务空间白名单,服务空间添加成功后,只有列表中的服务空间才可以调用API。此列表为空时,不校验调用方的服务空间。
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/a53fc41d-57a8-4a42-aa52-6ca6ff0ae609.png)
### 调用记录
系统可查看API的调用记录,但此业务数据量较大,为了维持服务的稳定性,只能查看30天内的某1天的全部调用记录,默认选择当天。
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/4e819c0d-820f-429d-82f0-6b24c26e4174.png)
# 开发指南
## 添加 uni-cloud-verify 扩展库依赖
在需要调用此API的云函数或云对象右键,添加依赖
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/c57bf00f-3c0e-4e5f-b979-996e7de20887.png)
勾选 uni-cloud-verify 扩展库依赖
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/665b7307-7506-42ad-ad3f-6c7c1d59569f.png)
## API@api
### 响应公共字段@publicreturn
|字段 |类型 |说明 |
|:-: |:-: |:- |
|errCode|Number |为0代表请求成功,其他均为请求失败,注意,请求成功不代表验证通过 |
|errMsg |String |请求失败的错误描述 |
|data |Object | 请求成功时,服务端返回的数据 |
### 获取uni认证管理对象@getuniverifymanager
云端在操作前,需要先获取 uniVerifyManager 对象实例,然后再通过 uniVerifyManager.xxx 调用对应的API
**云端代码**
```js
const uniVerifyManager = uniCloud.getUniVerifyManager({
provider: "univerify"
});
```
**请求参数**
|参数名 |类型 |必填 |默认值 |说明 |
|:-: |:-: |:-: |:-: |:- |
|provider |String |是 |- |必填,当前固定填写 univerify 即可 |
### 获取手机号三要素认证结果@mobile3metaverify
接口名:mobile3MetaVerify
你可以在调用 extStorageManager.mobile3MetaVerify 前执行一些自己的业务逻辑,判断用户是否有权限执行此API等等
**云端代码**
```js
const uniVerifyManager = uniCloud.getUniVerifyManager({
provider: "univerify"
});
let verifyRes = await uniVerifyManager.mobile3MetaVerify({
realName: "姓名",
idCard: "身份证",
mobile: "手机号",
});
console.log('认证结果: ', verifyRes.data);
```
**请求参数**
|参数名 |类型 |必填 |默认值 |说明 |
|:- |:-: |:-: |:-: |:- |
|realName |String |是 |- |姓名 |
|idCard |String |是 |- |身份证 |
|mobile |String |是 |- |手机号 |
**响应参数**
响应字段如下,响应通用字段已省略,详细见[响应公共字段](#publicreturn)
|名称 |类型 |必须返回 |描述 |
|:- |:-: |:-: |:- |
|status |Number |是 |认证结果,1-通过 2-不通过 3-查无结果 0-待定 |
|reasonType |Number |否 |原因详情:<br/>2-认证不一致 <br/>3-该手机号查询无记录 <br/>4-认证信息有误 <br/>5-号码状态异常(空号、停机等)<br/>6-解析手机号运营商失败<br/>7-其他出错 |
|taskId |String |是 |本次请求数据标识,可以根据该标识查询数据最新结果 |
|isPayed |Number |是 |本次请求是否收费标识,1代表收费,0代表不收费 |
|mobileType |String |是 |运营商类型:1-移动,2-联通,3- 电信,9,-未知 |
**响应体示例**
```json
{
"errCode": 0,
"errMsg": "",
"success": true,
"data": {
"status": 1,
"reasonType": 1,
"taskId": "9f9def8638c74506b3f5ef17f893c8b9",
"isPayed": 1,
"mobileType": "3",
"note": ""
}
}
```
\ No newline at end of file
## 费用说明
接口名称:手机号三要素认证-简版
### 资源包价格
|规格(次数) |价格(元) | 单价(元) |
|-- |-- |-- |
|20(限购1个) |4.6 |0.23 |
|100 |32 |0.32 |
|200 |62 |0.31 |
|500 |150 |0.3 |
|1000 |290 |0.29 |
|2000 |560 |0.28 |
|5000 |1350 |0.27 |
|10000 |2600 |0.26 |
|20000 |5000 |0.25 |
|50000 |12000 |0.24 |
|100000 |23000 |0.23 |
## 业务开通
### 开通流程
使用开发者账号登录[uniCloud控制台](https://unicloud.dcloud.net.cn/) ,选择`核验服务`栏目。在使用此功能前需要完成实名认证,可前往[开发者中心](https://dev.dcloud.net.cn/pages/user/info)完成实名认证。
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/49854ade-daa0-4865-a8c0-37ce54e0aaa5.png)
点击进入后会自动开通对应业务
### 购买资源包
【手机号三要素认证-简版】为预付费业务,使用之前,需要先进行购买资源包。点击页面上的“购买资源包”按钮,购买相应的资源包(目前只支持资源包的付费方式)
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/dbc18eac-6f8e-4efb-a8d7-939ec2eafc82.png)
### 安全配置
系统提供了 uniCloud 服务空间白名单安全配置,可以提高接口调用安全性,防止被他人盗用。可点击“添加”按钮,选择相应的服务空间完成添加服务空间白名单,服务空间添加成功后,只有列表中的服务空间才可以调用API。此列表为空时,不校验调用方的服务空间。
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/a53fc41d-57a8-4a42-aa52-6ca6ff0ae609.png)
### 调用记录
系统可查看API的调用记录,但此业务数据量较大,为了维持服务的稳定性,只能查看30天内的某1天的全部调用记录,默认选择当天。
![](https://web-ext-storage.dcloud.net.cn/unicloud/uni-rpia/4e819c0d-820f-429d-82f0-6b24c26e4174.png)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册