Description of HTTP API
Thanks For Using Our Device HTTP API!
Device HTTP API a software development API for all-series network encoding, decoding and converter device. Aimed at simple HTTP request/responding mechanism, Device HTTP API wants to realize various functions controlling for device. Software developers make use of Device HTTP API to meet the purpose of remote management and device control.
Each function of API corresponds to one HTTP request path. In current version, the path format is http://
This file will list each API’s corresponding filename and functions descriptions. Meanwhile, in each API description file, there will have one testing interface. You could write your request testing parameter according to parameter description, executing test, testifying API function online, very convenient.
API requests follow the standard HTTP protocol. Developers can use any tools, software development library that according with HTTP standard (For example Web browser, JavaScript library, C/C++ HTTP protocol file, JAVA, .NET etc.)
Submit of parameters might be POST or GET, or both (please refer to API instruction for details) according to different API interfaces request.
API’s response is JSON format. Please refer to each API instruction.
We maintain the conformity of API interfaces, but there may some differences due to products features difference leading different API interfaces. So please distinguish and deal with these minor differences according to offical guidance.
Call interface instructions
Return formal of all interface will be ：
- Normal return
{ "result": "ok", "data": some type of data，like alphabetic string，numerical value, object, array and so on, maybe there is array }：if no data field, then the return formal is:
{ result: "ok"}- wrong return
{ "result": "error", "msg": "error, invalid request!" "reason": "api:method"}note：it needs to call MsgCode interface to gain wrong message then to get the wrong information when msg is numerical value, for example：1100
{ "result": "error", "msg": "1100"}you can get the wrong message from MsgCode interface：
"1100": { "en": "Unable to connect to system services", "zh": "Unable to connect to system services"}modular list
| modular name | description |
|---|---|
| info | Pulbic information acquisition, inquiry SRT support, gain navigation bars（top mode） |
| source | decoding source abtain, increase, modifiy and remove |
| output | output information acquisition, configuration modify, resolution information acquisition,split screen layout configuration, output audio control |
| streamer | Streaming service publishing point management、streaming service management |
| network | Network parameter acquisition and configuration |
| sys-time | acquisition and configuration of area location, time information |
| sys | System control：Restart, quick reset and restore factory Settings |
| firmware | Firmware information acquisition and upgrade |
| platform | Platform management：Connect platform , get platform connection information |
| encode | Encoding parameter configuration：abtain encoding parameters, modify encoding parameters |
| sip | SIP/GB28181 communication： account add, modify, incoming, outgoing |
| MsgCode | error encoding inforation in background, bilingual in english and chinese |
| users | User operations related: user information, add, modify, delete , login, session validation |