1. 添加分组
- 接口功能描述：添加人脸等底库前，先添加分组，使底库能以分组形式管理
- 接口路径：[POST] http://设备IP:9091/ks/group
- 请求参数说明；
| 参数名称 | 数据类型 | 是否必须 | 说明 |
|---|---|---|---|
| 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..." } } |
表. 请求参数
- 请求示例；
| 项目 | 详情 |
|---|---|
| 请求格式 | JSON |
| 报文内容 | { "alg": "face", "name": "白名单", "ext": { "quality": 0.65 } } |
- 响应参数说明；
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
| message | String | 返回响应信息 |
| data | Null/Object | null |
- 响应示例。
| 项目 | 详情 |
|---|---|
| 报文格式 | JSON |
| 报文内容 | { "data": null, "error_code": 0, "message": { "zh": "新增底库分组成功！", "en": "Add group successful!" } } |
2. 修改分组
- 接口功能描述：修改分组信息；
- 接口路径：[PUT] http://设备IP:9091/ks/group；
- 请求参数说明；
| 参数名称 | 数据类型 | 是否必须 | 说明 |
|---|---|---|---|
| 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不传 |
表. 请求参数
- 请求示例；
| 项目 | 详情 |
|---|---|
| 请求格式 | JSON |
| 报文内容 | { "id": "6593e3aa522e4b9ab8454f54", "name": "白名单" } |
- 响应参数说明；
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
| message | String | 返回响应信息 |
| data | Null/Object | null |
- 响应示例。
| 项目 | 详情 |
|---|---|
| 报文格式 | JSON |
| 报文内容 | { "data": null, "error_code": 0, "message": { "zh": "更新底库分组成功！", "en": "Update group successful!" } } |
3. 查询分组
- 接口功能描述：查询分组；
- 接口路径：[GET] http://设备IP:9091/ks/group；
- 请求参数说明；
| 参数名称 | 数据类型 | 是否必须 | 说明 |
|---|---|---|---|
| alg | String | 是 | 底库类型face，work_clothes，ppe，open_lib |
表. 请求参数
- 请求示例；
| 项目 | 详情 |
|---|---|
| 请求格式 | Query String |
| alg | face |
- 响应参数说明；
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
| message | String | 返回响应信息 |
| data | Array | [] |
- 响应示例。
| 项目 | 详情 |
|---|---|
| 报文格式 | JSON |
| 报文内容 |
4. 删除分组
- 接口功能描述：删除分组；
- 接口路径：[DELETE] http://设备IP:9091/ks/group；
- 请求参数说明；
| 参数名称 | 数据类型 | 是否必须 | 说明 |
|---|---|---|---|
| ids | Array | 是 | 分组id数组 |
表. 请求参数
- 请求示例；
| 项目 | 详情 |
|---|---|
| 请求格式 | JSON |
| 报文内容 | { "ids": ["6593e3aa522e4b9ab8454f54"] } |
- 响应参数说明；
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
| message | String | 返回响应信息 |
| data | Null/Object | null |
- 响应示例。
| 项目 | 详情 |
|---|---|
| 报文格式 | JSON |
| 报文内容 | { "data": null, "error_code": 0, "message": { "zh": "删除底库分组成功！", "en": "Delete group successful!" } } |
回复