en:tvip_json_middleware_api:1
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision Last revision Both sides next revision | ||
|
en:tvip_json_middleware_api:1 [2016/10/03 09:42] Egor Danilenko создано |
en:tvip_json_middleware_api:1 [2017/11/17 13:28] Efim Karelink [Messages] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== TVIP JSON Middleware API v1 ====== | ====== TVIP JSON Middleware API v1 ====== | ||
| - | + | {{ :en:tvip_json_middleware_api:middleware_scheme.svg |}} | |
| - | {{:private:middleware_scheme.svg|}} | + | |
| ===== Basic request format ===== | ===== Basic request format ===== | ||
| Line 50: | Line 49: | ||
| ^HTTP code ^Commands | | ^HTTP code ^Commands | | ||
| - | | 403 | All,ex serverinfo,auth,register| | + | | 403 | All, except serverinfo,auth,register| |
| | 404 | All | | | 404 | All | | ||
| + | **All other** API requests should respond HTTP/200, even on error. Error code should be provided in "status" field of JSON responce object! | ||
| === Request HTTP Headers === | === Request HTTP Headers === | ||
| Line 534: | Line 534: | ||
| Supported message types:\\ | Supported message types:\\ | ||
| ^Message Type ^Source ^Description^ | ^Message Type ^Source ^Description^ | ||
| - | | user_message | server | Display text messages to user screen, availible types: notify, confirm. | | + | | user_message | server | Display text messages to user screen, available types: notify, confirm. | |
| | reinit | server | Ask client to refresh server_info. | | | reinit | server | Ask client to refresh server_info. | | ||
| | refresh_channel_list | server | Telling device to update channel list. | | | refresh_channel_list | server | Telling device to update channel list. | | ||
| | restart | server | Depending on the platform restarts app or OS. | | | restart | server | Depending on the platform restarts app or OS. | | ||
| + | | switch_to_channel | server | Switch the channel specified. Specify channel id as key-value //"channel_id":<channel_id>// element of //'args'// array. | | ||
| + | | start_application | server | Run the application specified. The application may be defined as key-value //"application":<short_app_name>// element of //'args'// array. | | ||
| + | | get_logs | server | Request to get logs and deliver them to the server. | | ||
| + | | get_screenshot | server | Request to make the screenshot from the current video playing and deliver them to the server. | | ||
| | open_url | server | Display data from given url to user screen. | | | open_url | server | Display data from given url to user screen. | | ||
| | force_update | server | Telling device to update app/firmware. | | | force_update | server | Telling device to update app/firmware. | | ||
en/tvip_json_middleware_api/1.txt · Last modified: 2017/11/17 20:29 by Efim Karelink
Page Tools
