...
Vnnox REST API均使用`host` + `resource` + `parameters` 的请求方式与服务器交互，`host`指服务器地址：https://cn.vnnox.com/，`resource`指资源及资源路径，一般为`Rest/{资源名}/`， `parameters`为资源标识或者查询参数：
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET {host}/Rest/Medias?offset=0&limit=10&search=&sort=last_amendment_time&sortType=desc
GET {host}/Rest/Medias/{media_id}
PUT {host}/Rest/Player/{player_id}
DELETE {host}/Rest/User/{user_id}
POST {host}/Rest/Worker |
如上面的例子，本文档所有涉及{host}均指https://cn.vnnox.com/，建议第三方开发者将{host}信息作为可配置项
错误调试
在REST API请求时会有3类错误：
1、服务级错误：网络或运营商导致的服务级别错误。（建议第三方应用中捕获http不等于2xx的状态码，如404、502等）
Code Block
firstline 1 title Error case 1 HTTP/1.1 502 Bad Gateway
2、系统级错误：REST API 请求中传入了非法参数或者数据格式错误。（建议第三方在应用中捕获 json.status[0] = 1）
Code Block
firstline 1 title Error case 2 HTTP/1.1 200 ok { "data": "系统级错误，请联系VNNOX管理员，谢谢！", "status": [1] }3、业务级错误：REST API因业务限制返回的状态码/错误码（json.status）。（建议第三方应用根据状态码说明处理API结果）
Code Block
firstline 1 title Error case 3 HTTP/1.1 200 ok { "http_code": 200, "data": { "roleName": "" }, "status": [50101201] }