跳到主要内容

接口概述

本接口可以使用httpwebsocket两种方式进行访问交互
websockethttp端口号为9911

http请求方式

  • 接口地址
    服务器地址:9912/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成功
1id不存在
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调用超时
31ocr没有识别到文字
32没有找到文字
33失败
34请先移除分组内的设备
35文件列表为空,或者列表内文件都不存在
36参数错误
37登录失败
38注册失败
39重置密码失败
40发送验证码失败
41不兼容的命令