欢迎您使用Device HTTP API!
Device HTTP API是为本型号网络解码和软件开发编程接口。Device HTTP API旨在通过简单的HTTP请求/响应机制, 实现对设备的各种功能控制。软件开发者利用Device HTTP API,可以达到远程管理和控制设备的目的。
API的每一个功能,对应有一个HTTP请求路径。在当前版本的API中,这个路径的格式是: http://
本文档将列出每一个API功能对应的文件名(filename)及其功能描述。同时,在每个API文档中,会有一个测试接口,您可以根据请求参数的描述,在测试接口中填写您需要进 行测试的请求参数,执行测试,可以在线验证API功能,十分方便。
API的请求遵循标准的HTTP协议,开发人员可以使用任何符合HTTP标准的工具、软件开发库来完成API调用(例如Web浏览器,JavaScript库,C/C++的HTTP协议库,JAVA,.NET等)。
参数的提交根据不同API的接口要求,可能为POST或GET,或者两者均可,具体请参见API说明。
API的响应为JSON格式,JSON对象中的每一个参数的意义,请参见每一个API的文档说明。
我们尽可能保持产品API接口的一致,但不可排除因产品特性差异而导致不同产品的API接口会存在部分差异。因此,请开发人员按照官方指导,区别和处理这些细节差异。
调用接口说明
所有接口的返回形式都统一为:
- 正常返回
{
"result": "ok",
"data": 某种类型的数据,比如字符串、数值、数组、对象等等,可能没有这个字段
}
无data字段返回示例:
{
"result": "ok"
}
- 错误返回
{
"result": "error",
"msg": "错误:无效的请求方法!",
"reason": "api:method"
}
注:当msg为数值时,需要调用MsgCode接口获取错误信息内容得到可读的错误信息,如:1100
{
"result": "error",
"msg": "1100"
}
通过MsgCode接口可以获取到错误信息:
"1100": {
"en": "Unable to connect to system services",
"zh": "无法连接系统服务"
}
模块清单
模块名 | 说明 |
---|---|
info | 公共信息获取、查询SRT支持、获取导航栏菜单(超级模式) |
source | 解码源获取、添加、修改、移除 |
output | 输出信息获取、配置修改、分辨率信息获取、分屏布局配置、输出音频控制 |
streamer | 流服务发布点管理、流服务管理 |
network | 网络参数获取与配置 |
sys-time | 区域位置、时间信息 获取和配置 |
sys | 系统控制:重启、快速复位、恢复出厂设置 |
firmware | 固件信息获取与升级 |
platform | 平台管理:连接平台配置、获取平台连接信息 |
encode | 编码参数配置:获取编码参数、修改编码参数 |
sip | SIP/GB28181通信相关:SIP账号添加、修改、呼入、呼出 |
MsgCode | 后台错误信息编码与中英文对照 |
users | 用户操作相关:用户信息、添加、修改、删除用户、登陆、session验证 |