接口概述
本接口可以使用http和websocket两种方式进行访问交互
websocket和http端口号为9911
http请求方式
接口地址
服务器地址:9911/api
例:http://127.0.0.1:9911/api请求方式
get,post提交json,post表单
websocket请求方式
使用websocket的方式请求接口可以获得更快的响应,但比http的请求方式复杂,所有请求结果都在回调函数内.
因为是异步的方式,如果想等待请求结果再进行下一步操作就需要进行异步转同步.
每个接口都会带msgid字段,服务端接收后会原样返回,用来异步转同步用.
接口地址
ws://服务器地址:9911/api
例:ws://127.0.0.1:9911/api请求内容格式
json
所有接口调用后都会返回成功与否,status为200代表成功,其他代表失败,失败的信息会在message说明
调用的结果是在data内,data内的code代表实际执行结果
| code码 | 描述 |
|---|---|
| 0 | 成功 |
| 1 | id不存在 |
| 2 | 设备没有绑定硬件 |
| 3 | 硬件没有连接 |
| 4 | 采集失败 |
| 5 | 有设备正在采集 |
| 6 | 此设备id没有在采集鼠标 |
| 7 | 设备id不存在或设备在线 |
| 8 | 扫码打开成功 |
| 9 | 进入采集页面 |
| 10 | 硬件id为空 |
| 11 | 没有鼠标参数 |
| 12 | 有硬件和手机连接 |
| 13 | 硬件未和手机连接 |
| 14 | 开始工作 |
| 15 | 没有坐标 |
| 16 | 硬件无法工作(未知的错误) |
| 17 | 失败重试 |
| 18 | 失败停止 |
| 19 | 有硬件和电脑连接 |
| 20 | 有硬件和电脑断开连接 |
| 21 | 正在工作中 |
| 22 | 设备在线 |
| 23 | 硬件未绑定设备 |
| 24 | 硬件未打开 |
| 25 | 设备不在线 |
| 26 | 截图失败 |
| 27 | 路径不存在 |
| 28 | 插件未连接 |
| 29 | 调用插件接口超时 |
| 30 | 调用超时 |
| 31 | ocr没有识别到文字 |
| 32 | 没有找到文字 |
| 33 | 失败 |
| 34 | 请先移除分组内的设备 |
| 35 | 文件列表为空,或者列表内文件都不存在 |
| 36 | 参数错误 |
| 37 | 登录失败 |
| 38 | 注册失败 |
| 39 | 重置密码失败 |
| 40 | 发送验证码失败 |
| 41 | 不兼容的命令 |