3. 人脸管理
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
1.1 | 新增人面 | /v1/iot/door/face/doorFaceRecognition/insertFaceRecognition | 1.0 |
1.2 | 查询人面 | /v1/iot/door/face/doorFaceRecognition/queryFaceRecognition | 1.0 |
1.3 | 移除人面 | /v1/iot/door/face/doorFaceRecognition/deleteFaceRecognition/{id} | 1.0 |
1.4 | 查询人面详细 | /v1/iot/door/face/doorFaceRecognition/queryFaceRecognitionInfo/{id} | 1.0 |
1.5 | 人脸图片上传 | /v1/iot/door/face/doorFaceRecognition/faceImageUploadAsync | 1.0 |
1.6 | 人脸图片删除 | /v1/iot/door/face/doorFaceRecognition/deleteFaceImage | 1.0 |
1.7 | 人脸日志查询 | /v1/iot/door/face/doorFaceRecognition/queryFaceLogs | 1.0 |
1.8 | 人脸图片校验 | /v1/iot/door/face/doorFaceRecognition/detectFaceImage | 1.0 |
1.9 | 人脸图片校验(不含业务) | /v1/iot/door/face/doorFaceRecognition/getStandardImage | 1.0 |
API调用
1.1: 新增人面
描述 新增人面
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/door/face/doorFaceRecognition/insertFaceRecognition
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
submitterId | body | string | n | 提交人id |
submitterName | body | string | n | 提交人 |
submitterType | body | string | n | 提交人类型 |
channel | body | string | n | 来源(web,app) |
imageUrl | body | string | y | 人面url |
projectId | body | string | y | 项目id |
personId | body | string | y | 人面人员id |
personName | body | string | y | 人脸人员名称 |
personType | body | string | y | 人脸人员类型 |
phone | body | string | y | 电话 |
请求Body描述(非Form表单数据)
{
"submitterId": "",
"submitterName": "潘生",
"submitterType": 7,
"channel": "1",
"imageUrl": "htttp://",
"projectId": "1111",
"personId": "728",
"personName": "潘生",
"personType": "1",
"phone": "13800138000"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
success | 顶层 | boolean | 是 | 是否成功 |
data | 顶层 | boolean | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"id": 2
}
}
1.2: 查询人面
描述 查询人面
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/door/face/doorFaceRecognition/queryFaceRecognition
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
pageNo | body | int | y | 页数 |
pageSize | body | int | y | 每页数量 |
projectId | body | string | y | 项目id |
personName | body | string | n | 人脸姓名 |
submitterName | body | string | n | 提交人 |
phone | body | string | n | 电话 |
personType | body | string | n | 人员类型 |
startTime | body | string | n | 开始时间 |
endTime | body | string | n | 结束时间 |
请求Body描述(非Form表单数据)
{
"pageNo": 1,
"pageSize": 10,
"projectId": "1111",
"personName": "潘生",
"submitterName": null,
"phone": "13800138000",
"personType": "1000,1001",
"startTime": "2020-01-01",
"endTime": "2020-02-02"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | y | 响应码标识 |
success | 顶层 | boolean | y | 是否成功 |
data | 顶层 | boolean | y | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"total": 5,
"list": [
{
"personName": "美团E",
"submitterType": "员工",
"createTime": "2020-09-21 15:25:23",
"phone": "15015173109",
"channel": "2",
"id": 1,
"submitterName": "李启鹏",
"personType": "特殊访客",
"imageUrl":"imageUrl",
"updateTime","2020-06-02",
"totalDevice":10,
"faceDevice": 10,
"totalAuth":10
}
]
}
}
1.3: 移除人面
描述 移除人面
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/door/face/doorFaceRecognition/deleteFaceRecognition/{id}
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
submitterId | body | string | n | 提交人id |
submitterName | body | string | n | 提交人 |
submitterType | body | string | n | 提交人类型 |
channel | body | string | n | 来源(web,app) |
projectId | body | string | y | 项目id |
personId | body | string | y | 人面人员id |
请求Body描述(非Form表单数据)
{
"submitterId": "",
"submitterName": "潘生",
"submitterType": 7,
"channel": "1",
"projectId": "1111",
"personId": "728"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | y | 响应码标识 |
success | 顶层 | boolean | y | 是否成功 |
data | 顶层 | boolean | y | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": true/false
}
1.4: 查询人面详细
描述 查询人面详细
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/iot/door/face/doorFaceRecognition/queryFaceRecognitionInfo/{id}
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | y | 响应码标识 |
success | 顶层 | boolean | y | 是否成功 |
data | 顶层 | boolean | y | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data":
{
"id": 7,
"personName": "潘生",
"personType": "业主",
"createTime": "2020-09-21 21:42:45",
"submitterName": "潘生",
"submitterType": "特殊访客",
"channel": "1",
"phone": "13800138000"
}
}
1.5: 人脸图片上传
描述 人脸图片上传
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/door/face/doorFaceRecognition/faceImageUploadAsync
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
personId | body | string | y | 人员id |
imageBase64 | body | string | y | 图片64 |
fileName | body | string | n | 图片名称 |
projectId | body | string | y | 项目id |
请求Body描述(非Form表单数据)
{
"personId": "1",
"imageBase64": "",
"fileName": "aa.jpg",
"projectId": "1"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
success | 顶层 | boolean | 是 | 是否成功 |
data | 顶层 | boolean | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"url": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/iot_box_image/aa.jpg"
}
}
1.6: 人脸图片删除
描述 人脸图片删除
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/door/face/doorFaceRecognition/deleteFaceImage
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
submitterId | body | string | n | 提交人id |
submitterName | body | string | n | 提交人 |
submitterType | body | string | n | 提交人类型 |
channel | body | string | n | 来源(web,app) |
projectId | body | string | y | 项目id |
personId | body | string | y | 人面人员id |
请求Body描述(非Form表单数据)
{
"submitterId": "",
"submitterName": "潘生",
"submitterType": 7,
"channel": "1",
"projectId": "1111",
"personId": "728"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
success | 顶层 | boolean | 是 | 是否成功 |
data | 顶层 | boolean | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": true
}
1.7: 人脸日志查询
描述 人脸日志查询
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/door/face/doorFaceRecognition/queryFaceLogs
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | string | y | 人脸主键id |
pageNo | body | int | y | 页码 |
pageSize | body | int | y | 页数 |
logType | body | int | y | 日志类型(UPDATE,AUTH) |
请求Body描述(非Form表单数据)
{
"pageNo": 1,
"pageSize": 10,
"id": 7,
"logType":"UPDATE"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
success | 顶层 | boolean | 是 | 是否成功 |
data | 顶层 | boolean | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"total": 3,
"list": [
{
"logType": "UPDATE",
"createTime": 1603674860000,
"updateTime": 1603674860000,
"faceId": 7,
"id": 65,
"version": 1,
"content": "1 潘生 添加人脸"
}
]
}
}
1.8: 人脸图片校验
描述 人脸图片校验
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/door/face/doorFaceRecognition/detectFaceImage
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
submitterId | body | string | n | 提交人id |
submitterName | body | string | n | 提交人 |
submitterType | body | string | n | 提交人类型 |
channel | body | string | n | 来源(web,app) |
projectId | body | string | y | 项目id |
personId | body | string | y | 人面人员id |
imageType | body | int | y | 图片类型 |
imageUrl | body | int | y | 图片url |
请求Body描述(非Form表单数据)
{
"submitterId": "",
"submitterName": "潘生",
"submitterType": 7,
"channel": "1",
"projectId": "1111",
"personId": "728",
"imageType": 0,
"imageUrl": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/iot_box_image/1.jpg",
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
success | 顶层 | boolean | 是 | 是否成功 |
data | 顶层 | boolean | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": true
}
1.9: 人脸图片校验(不含业务)
描述 人脸图片校验(不含业务)
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/door/face/doorFaceRecognition/getStandardImage
方法:POST
header
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
image64 | body | string | y | 图片64 |
fileName | body | string | y | 文件名 |
请求Body描述(非Form表单数据)
{
"image64": "image64",
"fileName": "xx.jpg"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
success | 顶层 | boolean | 是 | 是否成功 |
data | 顶层 | boolean | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"url": "https://mideazy-test-public.oss-cn-hangzhou.aliyuncs.com/iot_box_image/3b77accf95fa4e70b371a7c0ef4049e8WechatIMG896.jpg"
}
}