边缘计算视频智能分析AI盒子~人脸识别统一管理接口
人脸识别统一管理接口
当前文档对接口的描述采用HTTP的方式列举说明，同时也支持MQTT请求方式。使用方式参考框架接入说明，在向主题 /edge_app_controller发送请求时在请求参数中加入下方公共参数。
"Event":"/api_register_face" 请求接口名
"BoardId":"RJ-XXXXXXXXXXXXX" 请求的设备ID
一、人脸注册
Ø 接口说明
向指定人脸库注册人脸，albumName 当人脸库名称不存在时自动创建库。
Ø 接口地址 http://base_url/api_register_face
Ø 请求参数
{
"albumName":"new_album",
"name":"zhangsan",
"image":""
}
Ø 响应参数
{
"BoardId": "RJ-BMOX-C9580900E9F94587F2577979029D03DF",
"BoardIp": "fe80::2057:52ff:fe77:731e",
"Event": "/api_register_face",
"Result": {
"Code": 0,
"Desc": "成功"
},
"albumId": 8, //人脸库ID
"alignedImage":"****jpg base64" //注册人脸的特征图像（矫正后）
"croppedImage":"****jpg base64" //注册人脸的图（未矫正）
"photoId": 17, //注册后的人员ID
"photoName": "zhangsan" //注册的人员标识
}
一、人脸库创建
Ø 接口说明
手动创建人脸库
Ø 接口地址 http://base_url/api_repository_create
Ø 请求参数
{
"albumName":"manual_create"
}
Ø 响应参数
{
"BoardId": "RJ-BMOX-C9580900E9F94587F2577979029D03DF",
"BoardIp": "fe80::2057:52ff:fe77:731e",
"Event": "/api_repository_create",
"Result": {
"Code": 0,
"Desc": "成功"
},
"albumId": 9, //创建库的ID
"albumName": "manual_create"//创建库的名称
}
一、人脸库删除
Ø 接口说明
手动删除人脸库（及所有库内注册信息）
Ø 接口地址 http://base_url/api_repository_delete
Ø 请求参数
{
"albumName":"manual_create"
}
Ø 响应参数
{
"BoardId": "RJ-BMOX-C9580900E9F94587F2577979029D03DF",
"BoardIp": "fe80::2057:52ff:fe77:731e",
"Event": "/api_repository_delete",
"Result": {
"Code": 0,
"Desc": "成功"
},
"albumName": "manual_create"//删除库的名称
}
一、列出人脸库
Ø 接口说明
列出所有人脸库
Ø 接口地址 http://base_url/api_repositories_info
Ø 请求参数
{
}
Ø 响应参数
{
"BoardId": "RJ-BMOX-C9580900E9F94587F2577979029D03DF",
"BoardIp": "fe80::2057:52ff:fe77:731e",
"Event": "/api_repositories_info",
"Result": {
"Code": 0,
"Desc": "成功"
},
"data": [
{
"albumId": 7, //库ID
"albumName": "SS", //库名称
"pictureNo": 0 //库内人脸数量
},
{
"albumId": 8,
"albumName": "new_album",
"pictureNo": 1
}
],
"totalCount": 2 //人脸库数量
}
二、查询人脸库
Ø 接口说明
列出所有人脸库
Ø 接口地址 http://base_url/api_repository_info
Ø 请求参数
{
"albumName": "new_album"
}
Ø 响应参数
{
"BoardId": "RJ-BMOX-C9580900E9F94587F2577979029D03DF",
"BoardIp": "fe80::2057:52ff:fe77:731e",
"Event": "/api_repository_info",
"Result": {
"Code": 0,
"Desc": "成功"
},
"data": [
{
"albumId": 8,
"albumName": "new_album",
"pictureNo": 2
}
],
"totalCount": 1
}
三、查询人脸库中的人脸
Ø 接口说明
列出人脸库中的人脸
Ø 接口地址 http://base_url/api_repository_faces
Ø 请求参数
{
"albumName": "new_album", //需要查询的人脸库
"page": 0, // 查询第几页
"size": 1 //每页X条
}
Ø 响应参数
{
"BoardId": "RJ-BMOX-C9580900E9F94587F2577979029D03DF",
"BoardIp": "fe80::2057:52ff:fe77:731e",
"Event": "/api_repository_faces",
"Result": {
"Code": 0,
"Desc": "成功"
},
"data": [
{
"albumId": "new_album",
"photoId": 18,
"photoName": "zhangsan2"
}
],
"total": 2 //当前库人脸总数
}
四、更新人脸
Ø 接口说明
更新注册信息
Ø 接口地址 http://base_url/api_face_update
Ø 请求参数
{
"albumName":"new_album", //待更新人脸所在库
"name":"zhangsan_new_name", //更新后的名称
"photoId":22, //待更新ID
"image":"base64" //更新的图
}
Ø 响应参数
{
"BoardId": "RJ-BMOX-7DC00DBA811905A66A8EEDE127EF7A7F",
"BoardIp": "",
"Event": "/api_face_update",
"Result": {
"Code": 0,
"Desc": "成功"
},
"albumId": 11,
"alignedImage": "",
"croppedImage": "",
"photoId": 22,
"photoName": "zhangsan_new_name"
}
一、修改人脸库名称
Ø 接口说明
修改人脸库名
Ø 接口地址 http://base_url/api_repository_update
Ø 请求参数
{
"albumName":"new_album", //原名称
"name":"new_album2"
}
Ø 响应参数
{
"BoardId": "RJ-BMOX-C9580900E9F94587F2577979029D03DF",
"BoardIp": "fe80::2057:52ff:fe77:731e",
"Event": "/api_repository_update",
"Result": {
"Code": 0,
"Desc": "成功"
},
"albumId": 8,
"albumName": "new_album2"
}
二、注销人脸
Ø 接口说明
注销人脸
Ø 接口地址 http://base_url/api_face_delete
Ø 请求参数
{
"albumName":"new_album2", //删除哪个库的人脸
"photoId":18 //待删除的人脸ID
}
Ø 响应参数
{
"BoardId": "RJ-BMOX-C9580900E9F94587F2577979029D03DF",
"BoardIp": "fe80::2057:52ff:fe77:731e",
"Event": "/api_face_delete",
"Result": {
"Code": 0,
"Desc": "成功"
},
"albumId": 8,
"photoId": 18
}
三、图片人脸识别
Ø 接口说明
识别图片中人脸
Ø 接口地址 http://base_url/api/faceengine/face/1vn
Ø 请求参数
{
"albumIdList":[11], //待对比的人脸库ID, 类型是数组但目前只支持单库对比
"imageBase64":"×××××"
}
Ø 响应参数
{
"Result": {
"Code": 0,
"Desc": "成功"
},
"album1vnList": [
{
"Height": 172, //人脸位置
"Width": 136,
"X": 95,
"Y": 106,
"albumId": 11, //识别库ID
"photoId": 22, //相似度最高的人员ID
"score": 1.0000002384185791 //相似度
}
],
"totalCount": 1
}
人脸识别旧版本接口
人脸注
册（部分平台支持）
相关主题
发送：/edge_app_controller 响应：/edge_app_controller_reply
发送参数
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
响应参数
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.0.44及以上引入人脸库，请求参数变更如下
|
层级 |
参数 |
选项 |
类型 |
描述 |
取值范围 |
|
1 |
BoardId |
必选 |
String |
盒子唯一标识 |
|
|
1 |
Event |
必选 |
String |
功能标识 |
/api_register_face |
|
1 |
albumName |
必选 |
String |
库名称 |
人脸库名，不存在则自动创建 |
|
1 |
name |
必选 |
String |
用户标识 |
|
|
1 |
image |
必选 |
String |
用户照片 |
JPG/PNG |
相关主题
发送：/edge_app_controller 响应：/edge_app_controller_reply
发送参数
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
响应参数
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.0.44及以上引入人脸库，请求参数变更如下
|
层级 |
参数 |
选项 |
类型 |
描述 |
取值范围 |
|
1 |
BoardId |
必选 |
String |
盒子唯一标识 |
|
|
1 |
Event |
必选 |
String |
功能标识 |
/api_register_face |
|
1 |
albumId |
必选 |
Int |
库ID |
人脸列表接口返回 |
|
1 |
photoId |
必选 |
String |
用户ID |
人脸列表接口返回 |
相关主题
发送：/edge_app_controller 响应：/edge_app_controller_reply
发送参数
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
响应参数
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.0.44及以上引入人脸库，请求参数变更如下
|
层级 |
参数 |
选项 |
类型 |
描述 |
取值范围 |
|
1 |
BoardId |
必选 |
String |
盒子唯一标识 |
|
|
1 |
Event |
必选 |
String |
功能标识 |
/api_list_face |
|
1 |
page |
必选 |
Int |
页序号 |
0第一页 |
|
1 |
size |
必选 |
Int |
数量 |
每页返回数量 |
返回如下：
{
"BoardId" : "RJ-K8BOX-125E74BEA5A1A93487650CDFE3780A69",
"BoardIp" : "192.168.0.152",
"Content" :
{
"Faces" :
[
{
"aligned_file" : "Images/Repo2/4.thumb_align.png", //注册图保存位置
"createTime" : "2023-07-17 13:13:42",
"cropped_file" : "Images/Repo2/4.thumb_crop.png", //人脸对齐后的图保存位置
"detail" : null, //预留
"faceId" : "4",//用户名称
"repoName" : "C", //库名称
"repo_id" : 2, //库ID
"user_id" : 5 //用户ID
}
],
"Total" : 2 //总数
},
"Event" : "/api_list_face",
"Result" :
{
"Code" : 0,
"Desc" : "\u6210\u529f"
}
}