智驱力社区

1.业务场景

1.1.分组管理

1.新增分组.png

1.1.1.新增分组

接口调用顺序：2.1.1

2.编辑分组.png

1.1.2.编辑分组

接口调用顺序：2.1.2

1.1.3.查询分组

接口调用顺序：2.1.3

1.1.4.删除分组

接口调用顺序：2.1.4

1.2.人脸底库

1.2人脸.png

1.2.1.添加人脸分组内的人脸

人脸管理前端示例代码（点击此处跳转）
接口调用顺序：2.1.3 -> 2.2.1 ->2.2.6 -> 2.2.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.2.1：新增人脸信息
2.2.6：对新增的人脸绑定图片
2.2.5：载入底库，使新增的人脸图片生效，所有人脸添加完成后调用1次载入接口即可

1.2.2.修改人脸分组内的人脸

接口调用顺序：2.1.3 -> 2.2.3 -> 2.2.2 -> 2.2.6 -> 2.2.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.2.3：查询人脸信息，获取人脸信息ID
2.2.2：修改人脸结构化信息
2.2.6：修改人脸图片信息
2.2.5：载入底库，使修改的人脸图片生效，所有人脸修改完成后调用1次载入接口即可

1.2.3.查询人脸分组内的人脸

接口调用顺序：2.1.3 -> 2.2.3
说明：
2.1.3：查询分组信息，获取分组ID
2.2.3：查询人脸信息列表

1.2.4.删除人脸分组内的人脸

接口调用顺序：2.1.3 -> 2.2.3 -> 2.2.4 -> 2.2.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.2.3：查询人脸信息，获取人脸信息ID
2.2.4：删除人脸
2.2.5：载入底库，使删除生效，所有人脸删除完成后调用1次载入接口即可

1.2.5.批量导入人脸

接口调用顺序：2.1.3 -> 2.2.8
说明：
2.1.3：查询分组信息，获取分组ID
2.2.8：导入人脸包

1.2.6.批量导出人脸

接口调用顺序：2.1.3 -> 2.2.9
说明：
2.1.3：查询分组信息，获取分组ID
2.2.9 ：导出人脸包

1.2.7.载入人脸底库

接口调用顺序：2.2.5

1.3.工服底库

1.3工服.png

1.3.1.添加工服分组内的工服

接口调用顺序：2.1.3 -> 2.3.1 -> 2.3.6 -> 2.3.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.3.1：新增工服信息
2.3.6：对新增的工服绑定图片
2.3.5：载入底库，使新增的工服图片生效，所有工服添加完成后调用1次载入接口即可

1.3.2.修改工服分组内的工服

接口调用顺序：2.1.3 -> 2.3.3 -> 2.3.2 -> 2.3.6 -> 2.3.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.3.3：查询工服信息，获取工服信息ID
2.3.2：修改工服结构化信息
2.3.6：修改工服图片信息
2.3.5：载入底库，使修改的工服图片生效，所有工服修改完成后调用1次载入接口即可

1.3.3.查询工服分组内的工服

接口调用顺序：2.1.3 -> 2.3.3
说明：
2.1.3：查询分组信息，获取分组ID
2.3.3：查询工服信息列表

1.3.4.删除工服分组内的工服

接口调用顺序：2.1.3 -> 2.3.3 -> 2.3.4 -> 2.3.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.3.3：查询工服信息，获取工服信息ID
2.3.4：删除工服
2.3.5：载入底库，使删除生效，所有工服删除完成后调用1次载入接口即可

1.3.5.批量导入工服

接口调用顺序：2.1.3 -> 2.3.8
说明：
2.1.3：查询分组信息，获取分组ID
2.3.8：导入工服包

1.3.6.批量导出工服

接口调用顺序：2.1.3 -> 2.3.9
说明：
2.1.3：查询分组信息，获取分组ID
2.3.9 ：导出工服包

1.3.7.载入工服底库

接口调用顺序：2.3.5

1.4.PPE底库

1.4PPE.png

1.4.1.添加PPE分组内的PPE

接口调用顺序：2.1.3 -> 2.4.1 ->2.4.6 -> 2.4.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.4.1：新增PPE信息
2.4.6：对新增的PPE绑定图片
2.4.5：载入底库，使新增的PPE图片生效，所有PPE添加完成后调用1次载入接口即可

1.4.2.修改PPE分组内的PPE

接口调用顺序：2.1.3 -> 2.4.3 -> 2.4.2 -> 2.4.6 -> 2.4.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.4.3：查询PPE信息，获取工服信息ID
2.4.2：修改PPE结构化信息
2.4.6：修改PPE图片信息
2.4.5：载入底库，使修改的PPE图片生效，所有PPE修改完成后调用1次载入接口即可

1.4.3.查询PPE分组内的PPE

接口调用顺序：2.1.3 -> 2.4.3
说明：
2.1.3：查询分组信息，获取分组ID
2.4.3：查询PPE信息列表

1.4.4.删除PPE分组内的PPE

接口调用顺序：2.1.3 -> 2.4.3 -> 2.4.4 -> 2.4.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.4.3：查询PPE信息，获取PPE信息ID
2.4.4：删除PPE
2.4.5：载入底库，使删除生效，所有PPE删除完成后调用1次载入接口即可

1.4.5.批量导入PPE

接口调用顺序：2.1.3 -> 2.4.8
说明：
2.1.3：查询分组信息，获取分组ID
2.4.8：导入PPE包

1.4.6.批量导出PPE

接口调用顺序：2.1.3 -> 2.4.9
说明：
2.1.3：查询分组信息，获取分组ID
2.4.9 ：导出PPE包

1.4.7.载入PPE底库

接口调用顺序：2.4.5

1.5.开放底库

1.5开放底库.png

1.5.1.添加开放底库分组内的一条数据

接口调用顺序：2.1.3 -> 2.5.1 ->2.5.6 -> 2.5.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.5.1：新增一条数据
2.5.6：对新增的数据绑定图片
2.5.5：载入底库，使新增的图片生效，所有数据添加完成后调用1次载入接口即可

1.5.2.修改开放底库分组内的一条数据

接口调用顺序：2.1.3 -> 2.5.3 -> 2.5.2 -> 2.5.6 -> 2.5.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.5.3：查询一条数据，获取数据ID
2.5.2：修改结构化信息
2.5.6：修改图片信息
2.5.5：载入底库，使修改的图片生效，所有修改添加完成后调用1次载入接口即可

1.5.3.查询开放底库分组内的数据

接口调用顺序：2.1.3 -> 2.5.3
说明：
2.1.3：查询分组信息，获取分组ID
2.5.3：查询数据列表

1.5.4.删除开放底库分组内的数据

接口调用顺序：2.1.3 -> 2.5.3 -> 2.5.4 -> 2.5.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.5.3：查询数据，获取数据ID
2.5.4：删除数据
2.5.5：载入底库，使删除生效，所有数据删除完成后调用1次载入接口即可

1.5.5.批量导入开放底库数据

接口调用顺序：2.1.3 -> 2.5.8
说明：
2.1.3：查询分组信息，获取分组ID
2.5.8：导入开放底库数据包

1.5.6.批量导出开放底库信息

接口调用顺序：2.1.3 -> 2.5.9
说明：
2.1.3：查询分组信息，获取分组ID
2.5.9 ：导出开放底库数据

1.5.7.载入开放底库

接口调用顺序：2.5.5

2.原子接口

2.1 分组管理

2.1.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.1.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!" } }

2.1.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
报文内容

2.1.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!" } }

2.2 人脸底库

2.2.1. 添加人脸分组中的人脸信息

接口功能描述：添加人脸姓名、性别等至底库，最多1000个人脸；
接口路径：[POST] http://盒子IP:9091/ks/face
接口说明：如需上传人脸图片，请参照9.3.8.6修改人脸图像接口。
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
external_id	String	否	外部id
name	String	是	姓名
sex	String	否	性别
age	String	否	年龄
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "98", "name": "小明", "sex": "男", "age": "10" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	String	id

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": "6593e3aa522e4b9ab8454f54", "error_code": 0, "message": { "zh": "新增人脸成功！", "en": "Add face successful!" } }

2.2.2 修改人脸分组中的人脸信息

接口功能描述：修改人脸库信息；
接口路径：[PUT] http://盒子IP:9091/ks/face；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	人脸id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
name	String	否	姓名
sex	String	否	性别
age	String	否	年龄
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "98" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新人脸成功！", "en": "Update face successful!" } }

2.2.3. 查询人脸分组中的人脸信息

接口功能描述：查询人脸（按设备、姓名、外部id、更新时间查询）；
接口路径：[GET] http://盒子IP:9091/ks/face；
请求参数说明；

参数名称	数据类型	是否必须	说明
page	Int	是	页码
size	Int	是	每页数量
group_id	String	否	分组ID
external_id	String	否	外部id
name	String	否	姓名
start_time	Int	否	开始时间秒数
end_time	Int	否	结束时间秒数

表. 请求参数

请求示例；

项目	详情
请求格式	Query String
page	1
size	10
group_id	6593e3aa522e4b9ab8454f54
name	"1"

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目

详情

报文格式

JSON

报文内容

{
    "error_code": 0,
    "message": {
        "zh": "查询人脸成功！",
        "en": "Query face successful!"
    },
    "data": {
        "data": [
            {
                "id": "66f140cb5dc58a689059a3c2",
                "external_id": null,
                "group_id": "6593e3aa522e4b9ab8454f54",
               "name": "1",
                "age": 2,
                "sex": null,
                "desc": null,
                "feature": "[0.0016012939158827066,…]",
                "image": "/home/ema/ks/…… ",
                "update_time": 1727086969
            }
        ],
        "total": 1
    }
}

2.2.4. 删除人脸分组中的人脸信息

接口功能描述：删除人脸；
接口路径：[DELETE] http://盒子IP:9091/ks/face；
请求参数说明；

参数名称	数据类型	是否必须	说明
ids	Array	否	人脸id数组
group_id	String	否	若存在group_id，或者同时存在group_id和external_ids，则忽略ids
external_ids	Array	否

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "ids": ["6593e3aa522e4b9ab8454f54"] }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": "删除人脸成功！" }

2.2.5. 载入人脸底库

接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；
接口路径：[POST] http://盒子IP:9091/ks/face/load；
请求参数说明：无；
响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "载入成功！", "en": "Successful loaded!" } }

2.2.6. 添加或修改人脸图像

接口功能描述：添加或者修改人脸图像；
接口路径：[PUT] http://盒子IP:9091/ks/face/image；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	人脸id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
image	File	是	人脸图片

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
id	6593e3aa522e4b9ab8464f56
image	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新人脸成功！", "en": "Update face successful!" } }

2.2.7. 下载人脸导入模板

接口功能描述：下载模板；
接口路径：[GET] http://盒子IP:9091/ks/face/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
template	Bool	是	true

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
group_id	6593e3aa522e4b9ab8454f54
template	true

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

2.2.8. 批量导入人脸

接口功能描述：批量导入；
接口路径：[POST] http://盒子IP:9091/ks/face/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
package	File	是	文件

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
group_id	6593e3aa522e4b9ab8454f54
package	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "导入人脸底库成功！", "en": "Import face library successful!" } }

2.2.9. 批量导出人脸

接口功能描述：批量导出人脸底库；
接口路径：[GET] http://盒子IP:9091/ks/face/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
group_id	6593e3aa522e4b9ab8454f54

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

2.2.10. 提取人脸特征

接口功能描述：根据传入的人脸图片提取人脸特征；
接口路径：[POST] http://盒子IP:9091/ks/face/feature；
请求参数说明；

参数名称	数据类型	是否必须	说明
image	File	是	人脸图片
quality	Float	否	人脸质量阈值（默认值：0.35），当小于此阈值时将不提取特征

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Form Data
Image	(binary)
quality	0.35

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": […], "error_code": 0, "message": { "zh": "提取人脸特征成功！", "en": "Extract face feature successful!" } }

2.3 工服底库

2.3.1. 在工服分组中添加工服

接口功能描述：添加工服信息至底库，最多1000个工服；
接口路径：[POST] http://盒子IP:9091/ks/work_clothes；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
external_id	String	否	外部id
name	String	是	名称
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "123", "name": "红色工服" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	String	id

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": "65ad08db522e4b09379b5ad5", "error_code": 0, "message": { "zh": "新增工服成功！", "en": "Add workclothes successful!" } }

2.3.2. 修改工服组中的工服信息

接口功能描述：修改工服库信息；
接口路径：[PUT] http://盒子IP:9091/ks/work_clothes；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	工服id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
name	String	否	名称
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "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 workclothes successful!" } }

2.3.3. 查询工服分组中的工服

接口功能描述：查询工服（按设备、名称、外部id、更新时间查询）；
接口路径：[GET] http://盒子IP:9091/ks/work_clothes；
请求参数说明；

参数名称	数据类型	是否必须	说明
page	Int	是	页码
size	Int	是	每页数量
group_id	String	否	分组ID
external_id	String	否	外部id
name	String	否	名称
start_time	Int	否	开始时间秒数
end_time	Int	否	结束时间秒数

表. 请求参数

请求示例；

项目	详情
请求格式	Query String
page	1
size	10
group_id	6593e3aa522e4b9ab8454f54
name	红色工服
start_time	1704211200
end_time	1704384000

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目

详情

报文格式

JSON

报文内容

{
    "error_code": 0,
    "message": {
        "zh": "查询工服成功！",
        "en": "Query work_clothes successful!"
    },
    "data": {
        "data": [
            {
                "id": "66f14ddd5dc58a689059a3d5",
                "external_id": null,
                "group_id": "66f14c0d5dc58a689059a3cc",
                "name": "2",
                "desc": null,
                "feature": null,
                "image": null,
                "update_time": 1727090141
            }
        ],
        "total": 1
    }
}

2.3.4. 删除工服组中的工服

接口功能描述：删除工服；
接口路径：[DELETE] http://盒子IP:9091/ks/work_clothes；
请求参数说明；

参数名称	数据类型	是否必须	说明
ids	Array	否	工服id数组
group_id	String	否	分组ID
external_ids	Array	否	若存在group_id，或者同时存在group_id和external_ids，则忽略ids

表. 请求参数

请求示例；

项目	详情
请求格式	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 workclothes successful!" } }

2.3.5. 载入工服底库

接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；
接口路径：[POST] http://盒子IP:9091/ks/work_clothes/load；
请求参数说明：无；
响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "载入成功！", "en": "Successful loaded!" } }

2.3.6. 添加或修改工服图像

接口功能描述：添加或者修改工服图像；
接口路径：[PUT] http://盒子IP:9091/ks/work_clothes/image；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	工服id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
image	File	是	工服图片

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
id	6593e3aa522e4b9ab8454f54
image	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新工服成功！", "en": "Update workclothes successful!" } }

2.3.7. 下载工服导入模板

接口功能描述：下载模板；
接口路径：[GET] http://盒子IP:9091/ks/work_clothes/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
template	Bool	是	true

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
group_id	66cf14575dc58a095d35835a
template	true

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

2.3.8. 批量导入工服

接口功能描述：批量导入；
接口路径：[POST] http://盒子IP:9091/ks/work_clothes/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
package	file	是	文件

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
group_id	66cf14575dc58a095d35835a
package	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "导入工服底库成功！", "en": "Import work_clothes library successful!" } }

2.3.9. 批量导出工服

接口功能描述：批量导出工服底库；
接口路径：[GET] http://盒子IP:9091/ks/work_clothes/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
group_id	66cf14575dc58a095d35835a

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

2.3.10. 提取工服特征

接口功能描述：根据传入的工服图片提取工服特征；
接口路径：[POST] http://盒子IP:9091/ks/work_clothes/feature；
请求参数说明；

参数名称	数据类型	是否必须	说明
image	File	是	工服图片

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Form Data
Image	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": […], "error_code": 0, "message": { "zh": "提取工服特征成功！", "en": "Extract work_clothes feature successful!" } }

2.4 PPE底库

2.4.1. 添加PPE分组中的PPE信息

接口功能描述：添加PPE信息至底库，添加前判断限制最多1000个PPE信息；
接口路径：[POST] http://盒子IP:9091/ks/ppe；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
external_id	String	否	外部id
name	String	是	名称
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "123", "name": "眼部" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	String	id

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": "65ad08db522e4b09379b5ad5", "error_code": 0, "message": { "zh": "新增PPE成功！", "en": "Add PPE successful!" } }

2.4.2. 修改PPE分组中的PPE信息

接口功能描述：修改PPE信息；
接口路径：[PUT] http://盒子IP:9091/ks/ppe；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	PPE id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
name	String	否	名称
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "id": "6593e3aa522e4b9ab8456f5e", "name": "手部" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新PPE成功！", "en": "Update PPE successful!" } }

2.4.3. 查询PPE分组中的PPE信息

接口功能描述：查询PPE（按设备、分组、名称、外部id、更新时间查询）；
接口路径：[GET] http://盒子IP:9091/ks/ppe；
请求参数说明；

参数名称	数据类型	是否必须	说明
page	Int	是	页码
size	Int	是	每页数量
group_id	String	否	分组ID
external_id	String	否	外部id
name	String	否	名称
start_time	Int	否	开始时间秒数
end_time	Int	否	结束时间秒数

表. 请求参数

请求示例；

项目	详情
请求格式	Query String
page	1
size	10
group_id	6593e3aa522e4b9ab8454f54
name	手部
start_time	1704211200
end_time	1704384000

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目

详情

报文格式

JSON

报文内容

{
    "error_code": 0,
    "message": {
        "zh": "查询ppe成功！",
        "en": "Query ppe successful!"
    },
    "data": {
        "data": [
            {
                "id": "66f14d845dc58a689059a3d2",
                "external_id": null,
                "group_id": "66ed2fc05dc58a29cc68039c",
                "name": "1",
                "desc": null,
                "feature": null,
                "image": null,
                "update_time": 1727090052
            }
        ],
        "total": 1
    }
}

2.4.4. 删除PPE分组中的PPE信息

接口功能描述：删除工服；
接口路径：[DELETE] http://盒子IP:9091/ks/ppe；
请求参数说明；

参数名称	数据类型	是否必须	说明
ids	Array	否	PPE id数组
group_id	String	否	若存在group_id，或者同时存在group_id和external_ids，则忽略ids
external_ids	Array	否

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "ids": ["6593e3aa522e4b9ab8454f54"] }

响应参数说明

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "删除PPE成功！", "en": "Delete PPE successful!" } }

2.4.5. 载入PPE底库

接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；
接口路径：[POST] http://盒子IP:9091/ks/ppe/load；
请求参数说明：无；
响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "载入成功！", "en": "Successful loaded!" } }

2.4.6. 添加或修改PPE图像

接口功能描述：添加或者修改PPE图像；
接口路径：[PUT] http://盒子IP:9091/ks/ppe/image；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	工服id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
image	File	是	工服图片

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
id	6593e3aa522e4b9ab8454f54
image	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新PPE成功！", "en": "Update PPE successful!" } }

2.4.7. 下载PPE导入模板

接口功能描述：下载模板；
接口路径：[GET] http://盒子IP:9091/ks/ppe/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
template	Bool	是	true

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
group_id	66cf14575dc58a095d35835a
template	true

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

2.4.8. 批量导入PPE

接口功能描述：批量导入；
接口路径：[POST] http://盒子IP:9091/ks/ppe/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
package	File	是	文件

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
group_id	66cf14575dc58a095d35835a
package	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "导入ppe底库成功！", "en": "Import ppe library successful!" } }

2.4.9. 批量导出PPE

接口功能描述：批量导出ppe底库；
接口路径：[GET] http://盒子IP:9091/ks/ppe/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
group_id	66cf14575dc58a095d35835a

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

2.4.10. 提取PPE特征

接口功能描述：根据传入的PPE图片提取特征；
接口路径：[POST] http://盒子IP:9091/ks/ppe/feature；
请求参数说明；

参数名称	数据类型	是否必须	说明
image	File	是	PPE图片

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Form Data
Image	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": […], "error_code": 0, "message": { "zh": "提取ppe特征成功！", "en": "Extract ppe feature successful!" } }

2.5 开放底库

2.5.1. 添加开放底库分组中的信息

接口功能描述：添加开放信息至底库，添加前判断限制最多1000个开放底库；
接口路径：[POST] http://盒子IP:9091/ks/open_lib；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
external_id	String	否	外部id
name	String	是	名称
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "123", "name": "消防通道堵塞" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	String	id

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": "65ad08db522e4b09379b5ad5", "error_code": 0, "message": { "zh": "新增开放底库成功！", "en": "Add open lib successful!" } }

2.5.2. 修改开放底库

接口功能描述：修改开放底库信息；
接口路径：[PUT] http://盒子IP:9091/ks/open_lib；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	开放底库id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
name	String	否	名称
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
请求内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "id": "6593e3aa522e4b9ab8456f5e", "name": "逃生通道" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新开放底库成功！", "en": "Update open lib successful!" } }

2.5.3. 查询开放底库

接口功能描述：查询开放底库（按设备、分组、名称、外部id、更新时间查询）；
接口路径：[GET] http://盒子IP:9091/ks/open_lib；
请求参数说明；

参数名称	数据类型	是否必须	说明
page	Int	是	页码
size	Int	是	每页数量
group_id	String	否	分组ID
external_id	String	否	外部id
name	String	否	名称
start_time	Int	否	开始时间秒数
end_time	Int	否	结束时间秒数

表. 请求参数

请求示例；

项目	详情
请求格式	Query String
page	1
size	10
group_id	6593e3aa522e4b9ab8454f54
name	逃生通道
start_time	1704211200
end_time	1704384000

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目

详情

报文格式

JSON

报文内容

{
    "error_code": 0,
    "message": {
        "zh": "查询开放底库成功！",
        "en": "Query open library successful!"
    },
    "data": {
        "data": [
            {
                "id": "66f14e275dc58a689059a3d9",
                "external_id": null,
                "group_id": "66f14e225dc58a689059a3d7",
                "name": "1",
                "desc": null,
                "feature": null,
                "image": null,
                "update_time": 1727090215
            }
        ],
        "total": 1
    }
}

2.5.4. 删除开放底库

接口功能描述：删除工服；
接口路径：[DELETE] http://盒子IP:9091/ks/open_lib；
请求参数说明；

参数名称	数据类型	是否必须	说明
ids	Array	否	开放底库id数组
group_id	String	否	分组ID
external_ids	Array	否	若存在group_id，或者同时存在group_id和external_ids，则忽略ids

表. 请求参数

请求示例；

项目	详情
请求格式	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 open lib successful!" } }

2.5.5. 载入开放底库

接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；
接口路径：[POST] http://盒子IP:9091/ks/open_lib/load；
请求参数说明：无；
响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "载入成功！", "en": "Successful loaded!" } }

2.5.6. 添加或修改开放底库图像

接口功能描述：添加或者修改开放底库图像；
接口路径：[PUT] http://盒子IP:9091/ks/open_lib/image；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	工服id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
image	File	是	开放底库图片

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
id	6593e3aa522e4b9ab8454f54
image	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新开放底库成功！", "en": "Update open lib successful!" } }

2.5.7. 下载开放底库导入模板

接口功能描述：下载模板；
接口路径：[GET] http://盒子IP:9091/ks/open_lib/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
template	Bool	是	true

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
group_id	66cf14575dc58a095d35835a
template	true

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

2.5.8. 批量导入开放底库

接口功能描述：批量导入；
接口路径：[POST] http://盒子IP:9091/ks/open_lib/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
package	File	是	文件

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
group_id	66cf14575dc58a095d35835a
package	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "导入开放底库成功！", "en": "Import open library successful!" } }

2.5.9. 开放底库批量导出

接口功能描述：批量导出开放底库；
接口路径：[GET] http://盒子IP:9091/ks/open_lib/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
group_id	66cf14575dc58a095d35835a

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

2.5.10. 提取开放底库图片特征

接口功能描述：根据传入的图片提取特征（只提取区域内的特征）；
接口路径：[POST] http://盒子IP:9091/ks/open_lib/feature；
请求参数说明；

参数名称	数据类型	是否必须	说明
image	File	是	图片

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Form Data
Image	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": […], "error_code": 0, "message": { "zh": "提取开放底库特征成功！", "en": "Extract open library feature successful!" } }