概述
接口基准地址
http://localhost:5678/api
接口鉴权
在 Header 中添加 Authorization 字段，值为 Bearer {Token}
关于如何获取 Token 详见登录认证接口详见 登录认证接口
响应状态码说明
| 状态码 | 含义 | 说明 |
|---|---|---|
200 | OK | 请求成功 |
400 | BAD REQUEST | 请求格式错误、参数校验失败 |
401 | UNAUTHORIZED | 未提供授权信息 |
403 | FORBIDDEN | 认证失败 |
500 | INTERNAL SERVER ERROR | 内部错误 |
返回内容格式
数据返回格式统一使用 JSON
参数
类型
业务代码说明
| 状态码 | 说明 |
|---|---|
0 | 请求失败 |
1 | 请求成功 |
参数传递
除 GET 请求通过 URL 传递参数外，其它请求方式均通过 Body 传递参数
WebSocket 接口
基准地址
ws://localhost:5678
鉴权方式与 HTTP 接口相同
目前有两个业务
/api/ws实时数据推送/api/terminal终端服务