1. 添加分组
- 接口功能描述:添加人脸等底库前,先添加分组,使底库能以分组形式管理
- 接口路径:[POST] http://云服务IP:9191/ks/proxy/group
- 请求参数说明;
参数名称 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
device_ids | Array | 是 | 设备ID数组 |
alg | String | 是 | 底库类型face, work_clothes, ppe, open_lib |
name | String | 是 | 分组名称 |
ext | Object | 否 | alg为face ext格式为:{"quality": 0.65}(人脸质量) |
alg为work_clothes时ext不传 | |||
alg为ppe时ext不传 | |||
alg为open_lib 需要绘制ROI时 ext格式为:{ "alg": "open_lib", "name": "111", "ext": { "roi": [ { "id": "7a9065e6-0b20-4f94-b459-7fe5dafdfa17", "name": "", "coord": [ [0,0], [1269,0], [1269,790], [0,790] ] } ], "imgInfo": { "width": 1269, "height": 790, "mapWidth": 640, "mapHeight": 398 }, "image": "data:image/png;base64,iVBO..." } } |
表. 请求参数
参数名称 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
Authorization | String | 是 | ‘Bearer ’+ token; token通过获取token接口获取 |
表. 请求头
- 请求示例;
项目 | 详情 |
---|---|
请求格式 | JSON |
报文内容 | { "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"], "alg": "face", "name": "白名单", "ext": { "quality": 0.65 } } |
- 响应参数说明;
参数名称 | 数据类型 | 说明 |
---|---|---|
error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
message | String | 返回响应信息 |
data | Object | 以对象形式返回每个设备是否成功 |
- 响应示例。
项目 | 详情 |
---|---|
报文格式 | JSON |
报文内容 | { "data": { "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": { "id": null, "result": true, "reason": null } }, "error_code": 0, "message": { "zh": "新增底库分组成功!", "en": "Add group successful!" } } |
2. 修改分组
- 接口功能描述:修改分组信息;
- 接口路径:[PUT] http://云服务IP:9191/ks/proxy/group;
- 请求参数说明;
参数名称 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
device_id | String | 是 | 设备ID |
id | String | 是 | 分组ID |
name | String | 否 | 分组名称 |
ext | Object | 否 | alg为face ext格式为:{"quality": 0.65}(人脸质量) |
alg为work_clothes时ext不传 | |||
alg为ppe时ext不传 | |||
alg为open_lib 需要绘制ROI时 ext格式为:{ "roi": [ { "id": "8c6696ff-e89d-4e40-bbd5-d67a8eaed10a", "name": "", "coord": [ [ 273,176], [908, 170], [848, 477], [133, 479] ] } ], "imgInfo": {//仅用于显示,可以不传 "width": 1280, "height": 720, "mapWidth": 642, "mapHeight": 361 } } 不需要绘制ROI时,ext不传 |
表. 请求参数
参数名称 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
Authorization | String | 是 | ‘Bearer ’+ token; token通过获取token接口获取 |
表. 请求头
- 请求示例;
项目 | 详情 |
---|---|
请求格式 | JSON |
报文内容 | { "device_id": "c92254f2-6124-4f9d-b3e2-feb0f33c1df8", "id": "6593e3aa522e4b9ab8454f54", "name": "白名单" } |
- 响应参数说明;
参数名称 | 数据类型 | 说明 |
---|---|---|
error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
message | String | 返回响应信息 |
data | Null |
- 响应示例。
项目 | 详情 |
---|---|
报文格式 | JSON |
报文内容 | { "data": null, "error_code": 0, "message": { "zh": "更新底库分组成功!", "en": "Update group successful!" } } |
3. 查询分组
- 接口功能描述:查询分组;
- 接口路径:[GET] http://云服务IP:9191/ks/proxy/group;
- 请求参数说明;
参数名称 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
device_id | String | 是 | 设备ID |
alg | String | 是 | 底库类型face,work_clothes,ppe,open_lib |
表. 请求参数
参数名称 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
Authorization | String | 是 | ‘Bearer ’+ token; token通过获取token接口获取 |
表. 请求头
- 请求示例;
项目 | 详情 |
---|---|
请求格式 | Query String |
device_id | c92254f2-6124-4f9d-b3e2-feb0f33c1df8 |
alg | face |
- 响应参数说明;
参数名称 | 数据类型 | 说明 |
---|---|---|
error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
message | String | 返回响应信息 |
data | Array | [] |
- 响应示例。
项目 | 详情 |
---|---|
报文格式 | JSON |
报文内容 | { "error_code": 0, "message": { "zh": "查询底库分组成功!", "en": "Query group successful!" }, "data":[ { id: "666825ae5dc58a319bb9c1e8" device_id: "48e88878-5ae1-438b-b8a7-087f88535c76", name: "人脸分组1", alg: "face", exit: "{\"quality\": 0.5}", update_time:1718259380 } ] } |
4. 删除分组
- 接口功能描述:删除分组;
- 接口路径:[DELETE] http://云服务IP:9191/ks/proxy/group;
- 请求参数说明;
参数名称 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
device_ids | Array | 是 | 设备ID数组 |
ids | Array | 是 | 分组id数组 |
表. 请求参数
参数名称 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
Authorization | String | 是 | ‘Bearer ’+ token; token通过获取token接口获取 |
表. 请求头
- 请求示例;
项目 | 详情 |
---|---|
请求格式 | JSON |
报文内容 | { "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"], "ids": ["6593e3aa522e4b9ab8454f54"] } |
- 响应参数说明;
参数名称 | 数据类型 | 说明 |
---|---|---|
error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
message | String | 返回响应信息 |
data | Object | 以对象形式返回每个设备是否成功 |
- 响应示例。
项目 | 详情 |
---|---|
报文格式 | JSON |
报文内容 | { "data": { "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": { "result": true, "reason": null } }, "error_code": 0, "message": { "zh": "删除底库分组成功!", "en": "Delete group successful!" } } |
真诚点赞 诚不我欺
回复