Skip to main content

通用约定

响应格式​

读取类接口​

读取类接口（GET）通常直接返回业务数据对象，不包含 code 字段。例如：

{
  "sSerialNumber": "RC1126B-20240101-001",
  "sFirmwareVersion": "V1.0.10"
}

操作类接口​

操作类接口（POST、PUT、DELETE）返回包含 code 和 message 的对象：

{
  "code": 0,
  "message": "success"
}

code=0 表示成功，非零 code 表示出错，message 提供错误描述。

错误响应​

当请求失败时，设备会返回：

{
  "code": 401,
  "message": "Unauthorized: Invalid token or NO token provided"
}

字段命名​

JSON 字段名使用小驼峰命名法。首字母前缀表示数据类型：

前缀类型示例
i整型iCpuUsage
f浮点型fTemperature
s字符串sSerialNumber
b布尔型bRunning
l列表lDetection
d对象dIpv4

URL 构造​

CGI 接口​

大多数接口需要在前面加上 CGI 基础路径：

http://<DEVICE_IP>/cgi-bin/entry.cgi/<API_PATH>

直连路径接口​

部分接口会绕过 CGI 层，直接通过路径访问：

http://<DEVICE_IP>/api/v1/device/serial-port
http://<DEVICE_IP>/api/v1/file?path=/mnt/sdcard/test.mp4

鉴权​

除少数接口（/system/key、/system/login、/system/check）外，所有接口都需要在请求头中携带 Token：

Cookie: token=<JWT_TOKEN>

关于如何获取 Token，请参见 Authentication。

错误码​

错误码按功能模块进行分段：

前缀模块
100xx设备与系统
200xx实时预览
300xx录像
400xxAI 推理
500xx终端与日志

常见错误码：

错误码描述
10001密码强度过低
10002Token 已过期
10003固件下载已在进行中
10004端口号超出范围
10005端口号已被占用

完整列表请参见 Error Codes。

技术支持与产品讨论​

感谢您选择我们的产品！我们将为您提供多种支持，确保您在使用产品的过程中尽可能顺畅。我们提供多种交流渠道，以满足不同的偏好和需求。

Loading Comments...