HomMeeᴿAI 专注AI赋能 - 智能体开发工作流开发 RAG知识库搭建模型训练私有化部署

《基于平台软件webserver的二次开发》开篇说明

上位机软件是B/S架构的，如果用户有自己的前端页面显示风格，不想使用我们提供出来的标准显示UI，可自己编写前端代码，和智驱力的上位机软件webserver对接。实现用户想要的功能。

该方式是第三方和上位机平台的webserver做通信，使用前需先安装上位机管理平台。

上位机管理平台负责对盒子视频、告警汇聚与管理控制。该平台为轻量化webserver，内部已实现对盒子的集群管理功能，可私有化部署。第三方平台只需调用上位机管理平台接口，即可实现对盒子的数据纳管与远程管理，集成简单高效，适用于多台盒子集中管理场景。

开发统一标准

传输方式	采用HTTP/MQTT协议实现数据交互
数据格式	提交和返回值采用JSON格式
字符编码	统一采用UTF-8编码

平台与设备通过代理服务交互

平台-代理服务-设备交互流程图如下：

从平台侧可以分为五大模块，这五大模块分别调用代理服务的api接口。

设备管理：通过代理服务接口获取设备状态、添加摄像头、编辑摄像头、删除摄像头、查询摄像头；
算法管理：通过代理服务接口选择设备对算法进行下发（操作对象为设备级别，只下发算法不做算法绑定，算法绑定在添加摄像头中完成）；
告警信息：通过代理服务接口获取设备告警信息；
实时画面：通过代理服务接口获取摄像头实时画面；
系统设置：通过代理服务接口获取系统运行日志。

API 文档与测试工具

为了方便第三方开发者测试和使用 API，我们提供了以下工具和文档：

交互式API文档

地址：http://云服务IP:9191/docs ，http://云服务IP:9189/docs

Postman导入

如果需要将API导入到Postman，可以通过以下步骤实现：访问 http://云服务IP:9191/openapi.json 和 http://云服务IP:9189/openapi.json 获取 OpenAPI 规范文件。在 Postman 中，点击 Import 按钮，然后粘贴上述地址或上传下载的 openapi.json 文件。

数据源管理

具备对视频监控设备（硬盘录像机或视频监控系统、摄像机）、视频分析设备，新增、配置、删除、查询等操作。

1. 检测是否在线

接口功能描述：新增数据源时需要传入告警图片大小、编码格式，需要先通过此接口获取；
接口路径：[GET]http://云服务IP:9189/ks/proxy/stream/attr；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	设备ID
stream	String	是	视频流地址
draw_size	Int	是	默认填入1280即可
rtsp_transport	String	否	可选参数，缺省值为“tcp”，建议与新增数据源接口中的参数info-> rtsp_transport的值保持一致

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

请求示例；

项目	详情
请求格式	Query String
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
stream	rtsp://xxx/main/av\_stream
draw_size	1280
rtsp_transport	tcp

响应参数说明；

参数名称	数据类型	是否必须	说明
error_code	Int	是	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	是	返回响应信息
data	Object	是	如果数据源在线返回数据源信息，如果数据源不在线，返回空对象

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": { "codec": "h265", "fps": 25, "size": [1280, 720] }, "error_code": 0, "message": { "zh": "获取流状态成功！", "en": "Get stream status successful!" } }

2. 获取数据源画面

接口功能描述：获取数据源画面，绘制检测区域时调用获取；
接口路径：[GET]http://云服务IP:9189/ks/proxy/stream/image；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	设备ID
stream	String	是	视频流地址
draw_size	String	是	通过检测是否在线接口获取到的size,如[1280,720]

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

请求示例；

项目	详情
请求格式	Query String
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
stream	rtsp://xxx/main/av\_stream
draw_size	[1280,720]

响应参数说明；

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

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQ…", "error_code": 0, "message": { "zh": "获取图像成功！", "en": "Get image successful!" } }

3. onvif

接口功能描述：获取数据源信息，如品牌、码流地址等；
接口路径：[GET]http://云服务IP:9191/ks/proxy/source/onvif；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	设备ID
username	String	是	数据源onvif用户
password	String	是	数据源onvif密码
ip	String	是	数据源IP地址
port	Int	是	onvif协议端口，默认80

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

请求示例；

项目	详情
请求格式	Query String
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
username	admin
password	Admin123
ip	192.168.1.201
port	80

响应参数说明；

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

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": { ... }, "error_code": 0, "message": { "zh": "通过onvif获取摄像头信息成功！", "en": "Get camera information by onvif successful!" } }

4. 新增数据源

接口功能描述：新增数据源并配置相关算法、检测区域等；
接口路径：[POST] http://云服务IP:9191/ks/proxy/source；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	设备ID
id	String	否	数据源标识，可以传，不传则自动生成。注意：当协议为gb28181时，必须传id，且id为SIP用户名，比如：34020000002000000002
type	String	是	视频流：stream
desc	String	是	描述，注意同一个盒子不同数据源描述不可重复
ipv4	String	否	ip地址
stream	String	是	流地址
info	Object	否	当type为stream时参数格式如下： { "rtsp_transport": "tcp" }
draw_size	Array	是	告警图片大小[宽, 高]，检测是否在线接口返回的size
encoding	String	是	h264或h265，检测是否在线接口返回的codec
video_record	Int	是	是否录制视频，1录制，0不录制
alg	Object	否	获取算法配置文件（json格式），并填入配置文件中basicParams字段的内容，basicParams字段中给出参数的格式以及默认值。获取算法配置文件的接口（GET）：http://服务器IP:9192/algsjson/设备ID/算法名称.json，其中算法名称为算法英文名称。

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

请求示例；

项目

详情

请求格式

JSON

报文内容

{
"device_id": "c92254f2-6124-4f9d-b3e2-feb0f33c1df8",
"type": "camera",
"desc": "描述",
"ipv4": "192.168.1.33",
"stream": "rtsp://admin:Admin123@192.168.1.252:554/h264/ch1/main/av\_stream",
"info": {
"rtsp_transport": "tcp"
},
"draw_size": [1280, 720],
"encoding": "h264",
"video_record": 0,
"alg": {
"helmet": {
"alert_window": {
"interval": 5,
"length": 5,
"threshold": 3,
"type": "interval_threshold_window"
},
"bbox": {
"polygons": [{
"id": "27d590b2-3bc4-4bfb",
"name": "test",
"polygon": [
[391, 598],
[403, 451],
[711, 440],
[650, 591]
]
}
]
},
"plan": {
"1": [[0, 86399]],
"2": [[0, 86399]],
"3": [[0, 86399]],
"4": [[0, 86399]],
"5": [[0, 86399]],
"6": [[0, 86399]],
"7": [[0, 86399]]
},
"hazard_level": "",
"alg_type": "general",
"model_args": {
"helmet_classify": {
"conf_thres": 0.7
},
"helmet": {
"conf_thres": 0.35
},
"person": {
"conf_thres": 0.6
}
},
"reserved_args": {
"ch_name": "测试算法",
"sound_text": "测试检测报警"
}
}
}
}

响应参数说明；

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

响应示例；

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "添加数据源成功！", "en": "Add source successful!" } }

5. 编辑数据源

接口功能描述：编辑数据源信息；
接口路径：[PUT] http://云服务IP:9191/ks/proxy/source；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	参考“新增数据源”章节
id	String	是	参考“新增数据源”章节
type	String	否	参考“新增数据源”章节
desc	String	否	参考“新增数据源”章节
ipv4	String	否	参考“新增数据源”章节
stream	String	否	参考“新增数据源”章节
info	Object	否	参考“新增数据源”章节
draw_size	Array	否	参考“新增数据源”章节
alg	Object	否	参考“新增数据源”章节
video_record	Number	否	参考“新增数据源”章节
status	Bool	否	-1：停用，1：启用

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

请求示例；

项目	详情
请求格式	JSON
报文内容	参考“新增数据源”章节

响应参数说明；

参数名称	数据类型	是否必须	说明
error_code	Int	是	返回响应码 0: 成功 -1：失败
message	String	是	返回响应信息
data	Object	是	返回数据

响应示例。

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

6. 删除数据源

接口功能描述：删除数据源；
接口路径：[DELETE] http://云服务IP:9191/ks/proxy/source；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	设备ID
id	String	是	数据源ID

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

请求示例；

项目	详情
请求格式	JSON
报文格式	{ "device_id": "c92254f2-6124-4f9d-b3e2-feb0f33c1df8", "id": "65a78309522e4b4eec7605e0" }

响应参数说明；

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

响应示例；

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

7. 查询数据源

接口功能描述：查询数据源，不传参表示查询所有数据源；
接口路径：[GET] http://云服务IP:9191/ks/proxy/source；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	否	设备ID
id	String	否	数据源ID
desc	String	否	数据源描述
alg	String	否	算法名，如helmet
status	String	否	数据源状态

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

响应参数说明；

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

响应示例；

项目

详情

报文格式

JSON

报文内容

{
"data": {
"40b44373-765e-4d24-94dc-89e54f898158": {
"6593d066522e4b1f0c6b95f6": {
"index": 3,
"alg": {
"person_departure": {
"alert_window": {
"duration": 1,
"interval": 5,
"type": "interval_duration_window"
},
"bbox": {
"polygons": [
[[738, 523], [1158, 606], [1270, 498], [943, 473]]
]
},
"plan": {
"1": [[0, 86399]],
"2": [[0, 86399]],
"3": [[0, 86399]],
"4": [[0, 86399]],
"5": [[50410, 86399]],
"6": [[0, 86399]],
"7": [[0, 86399]]
},
"reserved_args": {
"btn_name": "标记岗位区域",
"ch_name": "离岗检测",
"must": true,
"sound_text": "人员离岗检测报警",
"strategy": "center"
}
}
},
"desc": "描述",
"draw_size": [1280, 720],
"encoding": "h264",
"info": {
"brand": "2",
"password": "Admin123",
"user_name": "admin"
},
"ipv4": "192.168.1.33",
"name": "",
"status": 1,
"stream": "rtsp://admin:Admin123@192.168.1.33:554/h264/ch1/main/av\_stream",
"type": "camera"
}
}
},
"error_code": 0,
"message": {
"zh": "查询数据源成功！",
"en": "Query source successful!"
}
}

8. 修改数据源排序

接口功能描述：修改数据源排序，用于控制界面显示数据源的顺序；
接口路径：[PUT] http://云服务IP:9191/ks/proxy/source/index；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	设备ID
id	String	是	数据源ID
offset	Int	是	偏移量，-1表示向上偏移一位，1表示向下偏移一位

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

响应参数说明；

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

响应示例；

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

9. 订阅实时视频流

获取视频流播放前端示例代码（点击此处跳转）

接口功能描述：订阅实时画面，获取实时画面播放地址；
接口路径：[GET] http://云服务IP:9189/ks/proxy/stream/live/subscribe；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	设备ID
source_id	String	是	数据源ID

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

请求示例；

项目	详情
请求格式	Query String
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
source_id	6593d066522e4b1f0c6b95f6

响应参数说明；

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

响应示例；

项目	详情
报文格式	JSON
报文内容	{ "data": "webrtc://192.168.1.88/live/d847a577-3e04-42bd-8cb9-c630b5dfbfc8/65ae0cc0522e4b4c6fee314d", "error_code": 0, "message": { "zh": "订阅实时视频流成功！", "en": "Subscribe stream successful!" } }

10. 取消订阅实时视频流

接口功能描述：取消订阅实时画面；
调用时机：调用编辑数据源接口之前调用此接口；
接口路径：[GET] http://云服务IP:9189/ks/proxy/stream/live/unsubscribe；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	是	设备ID
source_ids	Array	是	数据源ID数组

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

请求示例；

项目	详情
请求格式	Query String
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
source_ids	["6593d066522e4b1f0c6b95f6"]

响应参数说明；

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

响应示例

项目	详情
报文格式	JSON
报文内容	{ "data": { "65ae0cc0522e4b4c6fee314d": true }, "error_code": 0, "message": { "zh": "取消订阅实时视频流成功！", "en": "Unsubscribe stream successful!" } }

告警管理

1. 查询告警

接口功能描述：查询告警结果；
接口路径：[GET] http://云服务IP:9191/ks/proxy/alert；
请求参数说明；

参数名称	数据类型	是否必须	说明
page	Int	是	页码
size	Int	是	每页数量
device_ids	List	否	设备ID
source_desc	String	否	数据源
alg_ch_name	String	否	算法名称
hazard_level	String	否	危险等级
status	Int	否	告警状态
start_time	Int	否	开始时间秒数
end_time	Int	否	结束时间秒数

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Query String
page	1
size	10

响应参数说明；

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

响应示例。

项目

详情

报文格式

JSON

报文内容

{
    "data": {
        "data": [
         "id": "告警id",
        "alert_time": 1743561648,
         "device_id": "设备id",
         "device_name": "设备名",
         "device_desc": "",
        "source_id": "6784e22c5dc58ad87f124e96",
        "source_ipv4": "192.168.0.9",
        "source_desc": "40",
        "alg_name": "helmet",
        "alg_ch_name": "未佩戴安全帽检测",
        "hazard_level": "",
        // 访问路径：http://IP:9192/staticdata/image路径
        "image": "/opt/xxx/alert.jpg", 
        "reserved_data": "{}",
        // 访问路径：http://IP:9192/staticdata/video路径
        "video": "/opt/xxx/video.mp4",
        "status": 1,
        "desc": "[]"
        ],
        "total": 0
    },
    "error_code": 0,
    "message": {
        "zh": "查询告警成功！",
        "en": "Query alert successful!"
    }
}

### 2. 修改告警

接口功能描述：修改告警结果（告警确认）；
接口路径：[PUT] http://云服务IP:9191/ks/proxy/alert；
请求参数说明；

参数名称	数据类型	是否必须	说明
condition	Object	是	{ "alert_ids":告警id列表（可选，若存在此参数则忽略其它参数）， "device_ids": 设备ID（List，可选）, "source_desc": 数据源（String，可选）, "alg_ch_name": 算法名称（String，可选）, "hazard_level": 危险等级（String，可选）, "status": 告警状态（Int，可选）, "start_time": 开始时间秒数（Int，可选）, "end_time": 结束时间秒数（Int，可选） }
status	Int	否	告警状态。1：未处理，2：确认，3：销警
desc	Object	否	告警描述，用具记录告警的处理人、处理时间、处理意见等信息

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "condition": { "alert_ids": ["667d02375dc58a0ac4bc439f"] }, "status": 1， "desc": [{"time": "2024-10-31 11:21:42", "name": "王总", "opinion": "同意"}] }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	批量更新时，将以对象形式返回每个设备是否成功

响应示例。

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

3. 删除告警

接口功能描述：删除告警结果；(注：若不传参，则删除所有告警)
接口路径：[DELETE] http://云服务IP:9191/ks/proxy/alert；
请求参数说明；

参数名称	数据类型	是否必须	说明
condition	Object	是	{ "alert_ids":告警id列表（可选，若存在此参数则忽略其他参数）， "device_ids": 设备ID（List，可选）, "source_desc": 数据源（String，可选）, "alg_ch_name": 算法名称（String，可选）, "hazard_level": 危险等级（String，可选）, "status": 告警状态（Int，可选）, "start_time": 开始时间秒数（Int，可选）, "end_time": 结束时间秒数（Int，可选） }

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "condition": { "alert_ids": ["667d02375dc58a0ac4bc439f"] } }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	批量删除时，将以对象形式返回每个设备是否成功

响应示例。

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

4. 导出告警

接口功能描述：导出告警结果，调用时需要注意单次导出不超过1000条；
接口路径：[GET] http://云服务IP:9191/ks/proxy/alert/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
alert_ids	List	否	告警id列表，若存在此参数，则忽略其他参数
device_ids	List	否	设备ID
source_desc	String	否	数据源
alg_ch_name	String	否	算法名称
hazard_level	String	否	危险等级
status	Int	否	告警状态
start_time	Int	否	开始时间秒数
end_time	Int	否	结束时间秒数

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Query String
alert_ids	["667d02375dc58a0ac4bc439f"]

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

响应参数说明；

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

响应示例。

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

5. 根据告警id查询告警

接口功能描述：根据告警id查询告警结果；
接口路径：[GET] http://设备IP:9191/ks/proxy/alert/by\_id；
请求参数说明；

参数名称	数据类型	是否必须	说明
alert_id	String	是	告警id

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Query String
alert_id	667d02375dc58a0ac4bc439f

响应参数说明；

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

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "error_code": 0, "message": { "zh": "查询告警成功！", "en": "Query alert successful!" }, "data": {…} }

跨线计数

1. 查询跨线计数信息

接口功能描述：跨线计数信息查询；
接口路径：[GET] http://云服务IP:9191/ks/proxy/cross\_line\_counting；
请求参数说明；

参数名称	数据类型	是否必须	说明
page	Int	是	页码
size	Int	是	每页数量
device_name	String	否	设备名称
source_desc	String	否	数据源
alg_ch_name	String	否	算法名称
start_time	Int	否	开始时间秒数
end_time	Int	否	结束时间秒数

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Query String
page	1
size	10

响应参数说明；

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

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": { "data": [], "total": 0 }, "error_code": 0, "message": { "zh": "查询跨线计数成功！", "en": "Query cross_line_counting successful!" } }

算法管理

1. 算法下发

接口功能描述：算法下发；
接口路径：[POST] http://云服务IP:9191/ks/proxy/alg；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_ids	String	是	设备ID数组
package	File	是	算法包，应为.bin类型文件

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Form Data
device_ids	["20e0c32b-f937-4cf2-9e8c-96d1e60e6519"]
package	(binary)

响应参数说明；

参数名称	数据类型	说明
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": "Import algorithm successful!" } }

2. 算法查询

接口功能描述：对盒子算法查询；

接口路径：[GET] http://云服务IP:9191/ks/proxy/alg；

请求参数说明；

参数名称	数据类型	是否必须	说明
device_id	String	否	设备ID

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Query String
device_id	20e0c32b-f937-4cf2-9e8c-96d1e60e6519

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	返回数据,具体字段看下发接口

响应示例。

项目

详情

报文格式

JSON

报文内容

{
"data": {
"20e0c32b-f937-4cf2-9e8c-96d1e60e6519": [
{
"alert_label": "[\"未佩戴安全帽\"]",
"ch_name": "未佩戴安全帽检测",
"default_model": "{\"helmet\": {\"ch_name\": \"安全帽识别\", \"args\": {\"conf_thres\": 0.35}, \"label\": {\"class2label\": {\"0\": \"head\", \"1\": \"helmet\"}, \"label_map\": {\"head\": \"未佩戴安全帽\", \"helmet\": \"佩戴安全帽\"}}}, \"person\": {\"ch_name\": \"人体识别\", \"args\": {\"conf_thres\": 0.85}, \"label\": {\"class2label\": {\"0\": \"person\"}}}}",
"desc": "适用于工地、工厂场景下未佩戴安全帽检测;支持红色、黄色、蓝色、白色、黑色安全帽检测;画面需可分辨头部及安全帽特征;人员头部及安全帽目标不小于画面大小2‰;识别距离小于15m最佳（200万@6mm）",
"group_name": "人员管理",
"model": {
"helmet": {
"args": {
"conf_thres": 0.35
},
"ch_name": "安全帽识别",
"label": {
"class2label": {
"0": "head",
"1": "helmet"
},
"label_map": {
"head": "未佩戴安全帽",
"helmet": "佩戴安全帽"
}
}
},
"person": {
"args": {
"conf_thres": 0.85
},
"ch_name": "人体识别",
"label": {
"class2label": {
"0": "person"
}
}
}
},
"name": "helmet",
"process_time": 10,
"version": "v2.0"
}
]
},
"error_code": 0,
"message": {
"zh": "查询算法成功！",
"en": "Query algorithm successful!"
}
}

3. 算法删除

接口功能描述：删除盒子设备算法；
接口路径：[DELETE] http://云服务IP:9191/ks/proxy/alg；
请求参数说明；

参数名称	数据类型	是否必须	说明
device_ids	Array	是	设备ID数组
name	String	是	算法名，如helmet

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["20e0c32b-f937-4cf2-9e8c-96d1e60e6519"], "name": "helmet" }

响应参数说明；

参数名称	数据类型	说明
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 algorithm successful!" } }

系统管理

1. 获取系统参数

接口功能描述：获取系统参数；
接口路径：[GET] http://云服务IP:9191/ks/proxy/system/args；
请求参数:

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	以对象形式返回系统参数，包括安全策略、端口映射

表. 请求参数

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "error_code": 0, "message": { "zh": "查询系统参数成功！", "en": "Query system parameters successful!" }, "data": { "login": { "lockout": { "enable": false, "max_attempts": 5, "time": 1800 }, "captcha": { "enable": false, "expire": 60 } }, "map": { "srs_server": 1935, "srs_http_api": 1985, "srs_http_server": 8080, "websocket": 8083 } } }

MQTT消息

1. 告警信息

topic功能描述：订阅告警信息；
topic：ks/proxy/alert/+（表示订阅所有设备的告警信息）或者ks/proxy/alert/device_id（表示订阅指定device_id的设备的告警信息）；
对应平台位置：【数字大屏】右侧【实时监测】模块
响应示例。

项目

详情

报文格式

JSON

报文内容

{
    "msg_id": "uuid",
    "msg_type": "alert",
    "time": "发送时间",
    "data": {
        "id": "告警id",
        "alert_time": "时间戳",
        "device_id": "设备ID",
        "device_name": "设备名称",
        "device_desc": "设备描述",
        "source_id": "摄像头ID,对应新增摄像头的ID",
        "source_ipv4": "摄像头IP",
        "source_desc": "摄像头描述",
        "alg_name": "算法英文名称",
        "alg_ch_name": "算法中文名称",
        "image": "图片路径，访问需要加上代理http://云平台IP:9192/staticdata+图片路径",
        "reserved_data": "人脸告警才有数据",
        "hazard_level": "危害等级",
        "status": "摄像头状态"// 1: 启用，-1：停用
    }
}

reserved_data

{
  group:{
     "id": "666825ae5dc58a319bb9c1e8",
     "name": "分组名称",
},
face:[{
        "id": "6594e027522e4bbbcfe12194（唯一ID）",
        "name": "姓名",
        "age": "年龄",
        "sex": "性别",
        "desc": "描述",
        "update_time": "时间戳",
        "lib_image": "底库人脸图片",
        "cap_image": "抓拍人脸图片",
        "conf": "比对置信度"
    }
]
}

2. 实时结果

topic功能描述：订阅实时分析结果（播放流时产生MQTT消息）；
topic：ks/proxy/result/+（表示订阅所有设备的实时分析结果）或者ks/proxy/result/device_id（表示订阅指定device_id的设备的实时分析结果）；
对应平台位置：【数字大屏】
响应示例。

项目

详情

报文格式

JSON

报文内容

{
    "msg_id": "uuid",
    "msg_type": "result",
    "time": "2024-01-23 10:25:36.216528",
    "data": {
        "time": "1705976735.391402",
        "hit": false,
        "hazard_level": "", //危险等级
        "source": {
            "id": "摄像头id",
            "ipv4": "摄像头ip",
            "desc": "摄像头描述"
        },
        "device": {
            "id": "设备id",
            "name": "设备名称",
            "desc": "设备描述"
        },
        "alg": {
            "name": "算法英文名称",
            "ch_name": "算法中文名称",
        },
        "reserved_data": {
            "bbox": {
                "rectangles": [{
                        "xyxy": [680, 198, 1178, 696], //左上角、右下角坐标
                        "color": [0, 0, 255], //BGR颜色
                        "conf": 0.91, //置信度
                        "label": "未佩戴安全帽", //标签
                        "ext": {} //扩展字段
                    }
                ] //矩形数组
                "polygons": {
                    "xxxxxx": { //多边形id
                        "name": "离岗检测", //多边形名称
                        "color": [0, 0, 255], //BGR颜色
                        "polygon": [ //顶点坐标
                            [568, 205],
                            [920, 140],
                            [843, 471],
                            [576, 471]
                        ],
                        "ext": {} //扩展字段
                    }
                } //多边形对象
                "lines": {
                    "xxxxxx": { //线段id
                        "name": "线段1", //线段名称
                        "line": [[680, 198, ], [1178, 696]], //顶点坐标
                        "color": [0, 0, 255], //BGR颜色
                        "ext": {} //扩展字段
                    }
                } //线段对象
            }
        }
    }
}

3. 平台状态

topic功能描述：订阅平台发送的各类状态消息，这些消息包括：设备上下线、平台联网状态、设备数据源信息（当设备的数据源发生变更时）；
topic：ks/proxy/message；
响应示例。

项目

详情

报文格式

JSON

设备上下线报文内容

{
       "msg_id": "uuid",
       "msg_type": "device_status",
       "time": "发送时间"，
       "data": {
         "device_id":"d847a577-3e04-42bd-8cb9-c630b5dfbfc8",
         "status":0 // 0离线  1在线
       }
}

平台联网状态报文内容

{
       "msg_id": "uuid",
       "msg_type": "network",
       "time": "发送时间"，
       "data": 1 //1：联网  0：未联网

底库管理-分组管理

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

底库管理-人脸底库

1. 添加人脸库

接口功能描述：添加人脸姓名、性别等至底库，添加前判断限制最多1000个人脸；
接口路径：[POST] http://云服务IP:9191/ks/proxy/face；
接口说明：如需上传人脸图片，请参照9.2.10.6修改人脸图像接口。
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"], "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "98", "name": "小明", "sex": "男", "age": "10" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	以对象形式返回每个设备是否成功

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": { "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": { "id": "6593e3aa522e4b9ab8454f54", "result": true, "reason": null } }, "error_code": 0, "message": { "zh": "新增人脸成功！", "en": "Add face successful!" } }

2. 修改人脸库

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

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"], "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "98" }

响应参数说明；

参数名称	数据类型	说明
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": "Update face successful!" } }

3. 查询人脸库

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

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Query String
page	1
size	10
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
group_id	6593e3aa522e4b9ab8454f54
name	"张三"
start_time	1704211200
end_time	1704384000

响应参数说明；

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

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "error_code": 0, "message": { "zh": "查询人脸成功！", "en": "Query face successful!" }, "data": { "age": 1, "external_id": "98", "desc": "1234", "device_id": "df0fef91-a835-4197-bf59-c6ea18a492af", "id": "6593e3aa522e4b9ab8454f54", "image": "/9j/4AAQSkZJRg…", "name": "123", "sex": "男", "update_time": 1704351807 } }

4. 删除人脸库

接口功能描述：删除人脸；
接口路径：[DELETE] http://云服务IP:9191/ks/proxy/face；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
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": "删除人脸成功！" }

5. 载入底库

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

参数名称	数据类型	是否必须	说明
device_ids	Array	是	设备ID数组

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"] }

响应参数说明；

参数名称	数据类型	说明
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": "Successful loaded!" } }

6. 添加或修改人脸图像

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

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Form Data
device_ids	["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"]
id	6593e3aa522e4b9ab8464f56
image	(binary)

响应参数说明；

参数名称	数据类型	说明
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": "Update face successful!" } }

7. 下载模板

接口功能描述：下载模板；
接口路径：[GET] http://云服务IP:9191/ks/proxy/face/xlsx；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

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

请求示例；

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

响应参数说明；

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

响应示例。

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

8. 批量导入

接口功能描述：批量导入；
接口路径：[POST] http://云服务IP:9191/ks/proxy/face/xlsx；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Form Data
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
group_id	6593e3aa522e4b9ab8454f54
package	(binary)

响应参数说明；

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

响应示例。

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

9. 批量导出

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

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

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

请求示例；

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

响应参数说明；

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

响应示例。

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

底库管理-工服底库

1. 添加工服库

接口功能描述：添加工服信息至底库，添加前判断限制最多1000个工服；
接口路径：[POST] http://云服务IP:9191/ks/proxy/work\_clothes；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"], "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "123", "name": "红色工服" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	以对象形式返回每个设备是否成功

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": { "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": { "id": "65ad08db522e4b09379b5ad5" "result": true, "reason": null } }, "error_code": 0, "message": { "zh": "新增工服成功！", "en": "Add workclothes successful!" } }

2. 修改工服库

接口功能描述：修改工服库信息；
接口路径：[PUT] http://云服务IP:9191/ks/proxy/work\_clothes；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"], "group_id": "6593e3aa522e4b9ab8454f54", "id": "6593e3aa522e4b9ab8454f54", "name": "蓝色工服" }

响应参数说明；

参数名称	数据类型	说明
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": "Update workclothes successful!" } }

3. 查询工服库

接口功能描述：查询工服（按设备、名称、外部id、更新时间查询）；
接口路径：[GET] http://云服务IP:9191/ks/proxy/work\_clothes；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Query String
page	1
size	10
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
group_id	6593e3aa522e4b9ab8454f54
name	红色工服
start_time	1704211200
end_time	1704384000

响应参数说明；

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

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "error_code": 0, "message": { "zh": "查询工服成功！", "en": "Query workclothes successful!" }, "data": { "external_id ": "xxx ", "desc": "1234", "device_id": "df0fef91-a835-4197-bf59-c6ea18a492af", "id": "6593e3aa522e4b9ab8454f54", "image": "/9j/4AAQSkZJRg…", "name": "红色工服", "update_time": 1704351807 } }

4. 删除工服库

接口功能描述：删除工服；
接口路径：[DELETE] http://云服务IP:9191/ks/proxy/work\_clothes；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
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 workclothes successful!" } }

5. 载入底库

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

参数名称	数据类型	是否必须	说明
device_ids	Array	是	设备ID数组

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"] }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 -2: 服务端错误
message	String	返回响应信息
data	Object	以对象形式返回每个设备是否成功

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": { "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": { "result": true, "reason": null } }, "error_code": 0, "message": { "zh": "载入成功！", "en": "Successful loaded!" } }

6. 添加或修改工服图像

接口功能描述：添加或者修改工服图像；
接口路径：[PUT] http://云服务IP:9191/ks/proxy/work\_clothes/image；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Form Data
device_ids	["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"]
id	6593e3aa522e4b9ab8454f54
image	(binary)

响应参数说明；

参数名称	数据类型	说明
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": "Update workclothes successful!" } }

7. 下载模板

接口功能描述：下载模板；
接口路径：[GET] http://云服务IP:9191/ks/proxy/work\_clothes/xlsx；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

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

请求示例；

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

响应参数说明；

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

响应示例。

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

8. 批量导入

接口功能描述：批量导入；
接口路径：[POST] http://云服务IP:9191/ks/proxy/work\_clothes/xlsx；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Form Data
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
group_id	66cf14575dc58a095d35835a
package	(binary)

响应参数说明；

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

响应示例。

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

9. 批量导出

接口功能描述：批量导出工服底库；
接口路径：[GET] http://云服务IP:9191/ks/proxy/work\_clothes/xlsx；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

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

请求示例；

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

响应参数说明；

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

响应示例。

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

底库管理-PPE底库

1. 添加PPE库

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

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"], "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "123", "name": "眼部" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	以对象形式返回每个设备是否成功

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": { "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": { "id": "65ad08db522e4b09379b5ad5" "result": true, "reason": null } }, "error_code": 0, "message": { "zh": "新增PPE成功！", "en": "Add PPE successful!" } }

2. 修改PPE库

接口功能描述：修改PPE信息；
接口路径：[PUT] http://云服务IP:9191/ks/proxy/ppe；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"], "group_id": "6593e3aa522e4b9ab8454f54", "id": "6593e3aa522e4b9ab8456f5e", "name": "手部" }

响应参数说明；

参数名称	数据类型	说明
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": "更新PPE成功！", "en": "Update PPE successful!" } }

3. 查询PPE库

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

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Query String
page	1
size	10
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
group_id	6593e3aa522e4b9ab8454f54
name	手部
start_time	1704211200
end_time	1704384000

响应参数说明；

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

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "error_code": 0, "message": { "zh": "查询PPE成功！", "en": "Query PPE successful!" }, "data": { "external_id ": "xxx ", "group_id ": "xxx ", "desc": "1234", "device_id": "df0fef91-a835-4197-bf59-c6ea18a492af", "id": "6593e3aa522e4b9ab8454f54", "image": "/9j/4AAQSkZJRg…", "name": "手部", "update_time": 1704351807 } }

删除PPE库

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

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

表. 请求参数

参数名称	数据类型	是否必须	说明
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": "删除PPE成功！", "en": "Delete PPE successful!" } }

1. 载入底库

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

参数名称	数据类型	是否必须	说明
device_ids	Array	是	设备ID数组

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"] }

响应参数说明；

参数名称	数据类型	说明
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": "Successful loaded!" } }

2. 添加或修改PPE图像

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

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Form Data
device_ids	["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"]
id	6593e3aa522e4b9ab8454f54
image	(binary)

响应参数说明；

参数名称	数据类型	说明
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": "更新PPE成功！", "en": "Update PPE successful!" } }

3. 下载模板

接口功能描述：下载模板；
接口路径：[GET] http://云服务IP:9191/ks/proxy/ppe/xlsx；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

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

请求示例；

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

响应参数说明；

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

响应示例。

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

4. 批量导入

接口功能描述：批量导入；
接口路径：[POST] http://云服务IP:9191/ks/proxy/ppe/xlsx；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Form Data
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
group_id	66cf14575dc58a095d35835a
package	(binary)

响应参数说明；

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

响应示例。

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

5. 批量导出

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

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

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

请求示例；

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

响应参数说明；

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

响应示例。

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

底库管理-开放底库

1. 添加开放库

接口功能描述：添加开放信息至底库，添加前判断限制最多1000个开放底库；
接口路径：[POST] http://云服务IP:9191/ks/proxy/open\_lib；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"], "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "123", "name": "消防通道堵塞" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	以对象形式返回每个设备是否成功

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": { "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": { "id": "65ad08db522e4b09379b5ad5" "result": true, "reason": null } }, "error_code": 0, "message": { "zh": "新增开放底库成功！", "en": "Add open lib successful!" } }

2. 修改开放底库

接口功能描述：修改开放底库信息；
接口路径：[PUT] http://云服务IP:9191/ks/proxy/open\_lib；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
请求内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"], "group_id": "6593e3aa522e4b9ab8454f54", "id": "6593e3aa522e4b9ab8456f5e", "name": "逃生通道" }

响应参数说明；

参数名称	数据类型	说明
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": "Update open lib successful!" } }

3. 查询开放底库

接口功能描述：查询开放底库（按设备、分组、名称、外部id、更新时间查询）；
接口路径：[GET] http://云服务IP:9191/ks/proxy/open\_lib；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Query String
page	1
size	10
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
group_id	6593e3aa522e4b9ab8454f54
name	逃生通道
start_time	1704211200
end_time	1704384000

响应参数说明；

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

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "error_code": 0, "message": { "zh": "查询开放底库成功！", "en": "Query open lib successful!" }, "data": { "external_id ": "xxx ", "desc": "1234", "device_id": "df0fef91-a835-4197-bf59-c6ea18a492af", "id": "6593e3aa522e4b9ab8454f54", "image": "/9j/4AAQSkZJRg…", "name": "逃生通道", "update_time": 1704351807 } }

4. 删除开放底库

接口功能描述：删除工服；
接口路径：[DELETE] http://云服务IP:9191/ks/proxy/open\_lib；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
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 open lib successful!" } }

5. 载入底库

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

参数名称	数据类型	是否必须	说明
device_ids	Array	是	设备ID数组

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"] }

响应参数说明；

参数名称	数据类型	说明
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": "Successful loaded!" } }

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

接口功能描述：添加或者修改开放底库图像；
接口路径：[PUT] http://云服务IP:9191/ks/proxy/open\_lib/image；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Form Data
device_ids	["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"]
id	6593e3aa522e4b9ab8454f54
image	(binary)

响应参数说明；

参数名称	数据类型	说明
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": "Update open lib successful!" } }

7. 下载模板

接口功能描述：下载模板；
接口路径：[GET] http://云服务IP:9191/ks/proxy/open\_lib/xlsx；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

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

请求示例；

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

响应参数说明；

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

响应示例。

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

8. 批量导入

接口功能描述：批量导入；
接口路径：[POST] http://云服务IP:9191/ks/proxy/open\_lib/xlsx；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

请求示例；

项目	详情
请求格式	Form Data
device_id	c92254f2-6124-4f9d-b3e2-feb0f33c1df8
group_id	66cf14575dc58a095d35835a
package	(binary)

响应参数说明；

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

响应示例。

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

9. 批量导出

接口功能描述：批量导出开放底库；
接口路径：[GET] http://云服务IP:9191/ks/proxy/open\_lib/xlsx；
请求参数说明；

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

表. 请求参数

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

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

请求示例；

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

响应参数说明；

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

响应示例。

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

Token

1. 获取token

需要登录上位机平台（“后台管理”->“系统设置”->“运维系统”->“安全设置”）查看Access Key ID和Access Key Secret

接口功能描述：获取token；
接口路径：[GET]http://云服务IP:9191/ks/proxy/user/token；
请求参数说明；

参数名称	数据类型	是否必须	说明
signature	String	是	签名，生成方式见生成signature
ak	String	是	Access Key ID
timestamp	Int	是	时间戳秒数，可通过获取系统时间戳接口获取，如1722995536
nonce	String	是	UUID，长度不超过64

请求示例；

项目	详情
请求格式	Query String
signature	935816eb7b881e37a1761856……
ak	66b1dc29ca6e4e…….
timestamp	1722995536
nonce	skaoqpcnskjnklamk

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	String	token，如果校验失败，返回空

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": "eyJhbGciOiJIUzUxMiIsImlhdCI6MTYy…", "error_code": 0, "message": { "zh": "获取token成功！", "en": "Get token successful!" } }

2. 生成signature

需要登录上位机平台查看Access Key ID和Access Key Secret

Python示例：

import hashlibimport hmacimport logging# 配置日志记录器LOGGER = logging.getLogger(__name__)logging.basicConfig(level=logging.INFO)defgenerate_signature(sk: str, ak: str, timestamp: int, nonce: str) -> str:    """    生成数据的HMAC-SHA256签名    Args:        sk: 秘钥        ak: 用户id        timestamp: 时间戳（秒）        nonce: UUID，长度不超过64    Returns: 签名    """try:        iflen(nonce) > 64:            LOGGER.error('The length of nonce is too long: {}, limit is 64'.format(len(nonce)))            returnNone        message = '{}:{}:{}'.format(ak, timestamp, nonce)        sk_bytes = sk.encode('utf-8')        data_bytes = message.encode('utf-8')        hmac_obj = hmac.new(sk_bytes, data_bytes, hashlib.sha256)        signature = hmac_obj.hexdigest()        return signature    except Exception as e:        LOGGER.exception('generate_signature')        returnNone# 示例使用sk = 'Access Key Secret'ak = 'Access Key ID'timestamp = int(time.time())nonce = 'random_string'signature = generate_signature(sk, ak, timestamp, nonce)print('Signature:', signature)复制代码

JAVA示例：

import javax.crypto.Mac;import javax.crypto.spec.SecretKeySpec;import java.nio.charset.StandardCharsets;import java.security.MessageDigest;import java.util.logging.Logger;publicclassSignatureGenerator {    privatestaticfinalLoggerLOGGER= Logger.getLogger(SignatureGenerator.class.getName());    publicstatic String generateSignature(String sk, String ak, long timestamp, String nonce) {        try {            if (nonce.length() > 64) {                LOGGER.severe("The length of nonce is too long: " + nonce.length() + ", limit is 64");                returnnull;            }            Stringmessage= String.format("%s:%d:%s", ak, timestamp, nonce);            MachmacSHA256= Mac.getInstance("HmacSHA256");            SecretKeySpecsecretKey=newSecretKeySpec(sk.getBytes(StandardCharsets.UTF_8), "HmacSHA256");            hmacSHA256.init(secretKey);            byte[] hash = hmacSHA256.doFinal(message.getBytes(StandardCharsets.UTF_8));            StringBuilderhexString=newStringBuilder(2 * hash.length);            for (byte b : hash) {                Stringhex= Integer.toHexString(0xff & b);                if (hex.length() == 1) {                    hexString.append('0');                }                hexString.append(hex);            }            return hexString.toString();        } catch (Exception e) {            LOGGER.severe("generate_signature: " + e.getMessage());            returnnull;        }    }    publicstaticvoidmain(String[] args) {        Stringsk="Access Key Secret";        Stringak="Access Key ID";        longtimestamp= System.currentTimeMillis() / 1000;        Stringnonce="random_string";        Stringsignature= generateSignature(sk, ak, timestamp, nonce);        System.out.println("Signature: " + signature);    }}复制代码

JavaScript示例：

<!DOCTYPE html>    <scriptsrc="https://cdn.bootcss.com/crypto-js/3.1.9-1/crypto-js.js"></script><script>var ak = 'ak';        var sk = 'sk';var timestamp = 1722995536;var nonce = 'nekjwdfka';var message =`${ak}:${timestamp}:${nonce}`;        var hash = CryptoJS.HmacSHA256(message, sk);        var signature = CryptoJS.enc.Hex.stringify(hash);    </script></html>复制代码

3. 获取系统时间戳

接口功能描述：获取系统时间；
接口路径：[GET]http://云服务IP:9191/ks/proxy/system/time；
请求参数: 无；
响应参数说明；

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

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": 1725246379, "error_code": 0, "message": { "zh": "查询系统时间成功！", "en": "Query system time successful!" } }

4. 更新token

接口功能描述：更新token（token过期时间为1小时）；
接口路径：[GET]http://云服务IP:9191/ks/proxy/user/token_by_token；
请求参数:

参数名称	数据类型	是否必须	说明
Authorization	String	是	‘Bearer ’+ token; token通过获取token接口获取

响应参数说明；

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

l 响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": "eyJhbGciOiJIUzUxMiIsImlhdCI6MTYy…", "error_code": 0, "message": { "zh": "获取token成功！", "en": "Get token successful!" } }

5. Postman快速获取token

打开postman中的http://云服务IP:9191/ks/proxy/user/token 接口，在此接口的Scripts标签页的Pre-request，如下图位置添加代码即可快速获取token。可将此接口设置为前置接口。

varCryptoJS = require('crypto-js');var ak = "67c028f1c38062137d1b88d1";   // 上位机后台查看var sk = "19f07f37-5b13-4482-94fb-3f7ad0b5d547"; // 上位机后台查看var timestamp = Math.floor(Date.now() / 1000);var nonce = Math.random().toString(36).substring(2, 18); var message = `${ak}:${timestamp.toString()}:${nonce}`;var hash = CryptoJS.HmacSHA256(message, sk);var signature = CryptoJS.enc.Hex.stringify(hash);console.log("ak:", ak);console.log("timestamp:", timestamp);console.log("nonce:", nonce);console.log("signature:", signature);// 清除旧的查询参数pm.request.url.query.clear();pm.request.url.addQueryParams([    { key: 'ak', value: ak },    { key: 'timestamp', value: timestamp.toString() },    { key: 'nonce', value: nonce },    { key: 'signature', value: signature }]);

HomMeeᴿAI

将人工智能构建到您的业务中

开发统一标准

平台与设备通过代理服务交互

API 文档与测试工具

1. 检测是否在线

2. 获取数据源画面

3. onvif

4. 新增数据源

5. 编辑数据源

6. 删除数据源

7. 查询数据源

8. 修改数据源排序

9. 订阅实时视频流

10. 取消订阅实时视频流

1. 查询告警

3. 删除告警

4. 导出告警

5. 根据告警id查询告警

1. 查询跨线计数信息

1. 算法下发

2. 算法查询

3. 算法删除

1. 获取系统参数

1. 告警信息

2. 实时结果

3. 平台状态

1. 添加分组

2. 修改分组

3. 查询分组

4. 删除分组

1. 添加人脸库

2. 修改人脸库

3. 查询人脸库

4. 删除人脸库

5. 载入底库

6. 添加或修改人脸图像

7. 下载模板

8. 批量导入

9. 批量导出

1. 添加工服库

2. 修改工服库

3. 查询工服库

4. 删除工服库

5. 载入底库

6. 添加或修改工服图像

7. 下载模板

8. 批量导入

9. 批量导出

1. 添加PPE库

2. 修改PPE库

3. 查询PPE库

删除PPE库

1. 载入底库

2. 添加或修改PPE图像

3. 下载模板

4. 批量导入

5. 批量导出

1. 添加开放库

2. 修改开放底库

3. 查询开放底库

4. 删除开放底库

5. 载入底库

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

7. 下载模板

8. 批量导入

9. 批量导出

1. 获取token

2. 生成signature

3. 获取系统时间戳

4. 更新token

5. Postman快速获取token

将人工智能构建到
您的业务中