# Http 接口

企业可通过Http 接口,访问节点官方服务器- 通过官方云控 控制终端设备
视频教程

# 接口概述

  • Host地址: https://card.nspirit.cn

  • 支持 POST 方式请求

  • 返回格式 JSON
{
    code:0,
    msg:"是否成功的消息提示"
    data:{} --//泛型 具体逻辑,返回具体类型
}
1
2
3
4
5

# 获取Token

  • 请求地址: Host + "/api/v1/devLogin"

参数

  • name : 开发者用户名称
  • pwd : 开发者用户密码
  • 返回结构
{
    "code": 1,
    "msg": "ok",
    "data": {
        "token": "a626987365b04a731eec80675fe41705",
        "name": "游自在",
        "is_vip": 1,
        "vip_expired": "2100-01-01 00:00:00",
        "vipId": 0,
        "vipName": "",
        "from": 1,
        "is_ad": 1,
        "applyList": []
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 获取设备列表

  • 请求地址: Host + "/api/v1/getDeviceList"
  • 返回结构
{
    "code": 1,
    "msg": "ok",
    "sign": "PMPHJ+GQngf/yTh3yJZ9AA==",
    "signx": "1CjubZqa6zX578mkcfXesvyp2cf4eLOZU5F3ueWP9We5lHQd5TyEJiVX1PLkhdcs",
    "data": [
        {
            "device_id": "3c75bb99-ce81-4e29-86d2-d18cefec8058",
            "device_name": "vivovivo x6a",
            "img": null,
            "params": null,
            "state": null
        },
        {
            "device_id": "b49379bf-aae6-45fe-81a3-74ed63dfcfbd",
            "device_name": "XiaomiM2007J17C",
            "img": "https://nscontrol.oss-cn-hangzhou.aliyuncs.com/ad2efc1e-4724-4c27-8192-69606c943098.jpg",
            "params": null,
            "state": null
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 运行线上辅助

  • 请求地址: Host + "api/v1/startApp"

参数

  • token 必填 : 登陆后获取到的token值
  • apply_id 必填 : 线上辅助的id
  • scriptlua 选填 : 在运行线上辅助之前运行的代码,可以作为云控脚本的执行参数
  • deviceIds 选填 : 指定哪些设备需要运行辅助
    • 不填,则所有设备都运行
    • 多个id 请用 "," 号隔开 如:"id1,id2,id3"
  • 返回结构
{
    code:1,
    msg:"成功"
}
1
2
3
4

# 运行Lua命令

  • 请求地址: Host + "/api/v1/runApp"

参数

  • token 必填 : 登陆后获取到的token值
  • scriptlua 必填 : lua脚本
    • 需要传入lua 指令,可混合节点Api
  • deviceIds 选填 : 指定哪些设备需要运行Lua命令
    • 不填,则所有设备都运行
    • 多个id 请用 "," 号隔开 如:"id1,id2,id3"
  • 返回结构
{
    code:1,
    msg:"成功"
}
1
2
3
4

# 停止辅助

  • 请求地址: Host + "/api/v1/runApp"

参数

  • 返回结构
{
    code:1,
    msg:"成功"
}
1
2
3
4

# 通知设备上传截图

接口调用 成功后, 请重新获取设备列表,截图地址就在设备列表下“img” 字段

  • 请求地址: Host + "/api/v1/imgApp"

参数

  • 返回结构
{
    code:1,
    msg:"成功"
}
1
2
3
4

# WebSocket 接口

# WebSocket-Server【Demo】

Server 端逻辑需要企业用户自己实现,我们只提供nodejs 环境下的 demo代码

# 设备信息

客户端需要填写您的websokcet server 地址 去连接服务器
视频教程

连接成功后,节点APP或小精灵会主动向服务端发送当前设备的具体信息

{
    "deviceId":"c13bb8e2-96fc-4a92-80a0-0d1d5cf0db0a", //设备id,用于识别设备
    "deviceName":"XiaomiM2007J17C" //设备的名称
}
1
2
3
4

# 运行线上辅助指令

  • 指令
{
    "deviceId":"c13bb8e2-96fc-4a92-80a0-0d1d5cf0db0a",//设备id,用于识别设备
    "type":0,
    "data":{
        "cmd":1, //启动命令为1
        "scriptid":198, //线上辅助id
        "preLua":"home();a =10;" //可在执行辅助前,运行一段lua,可以用此函数植入一些参数
        }
    }
1
2
3
4
5
6
7
8
9

# 运行Lua指令

  • 指令
{
    "deviceId":"c13bb8e2-96fc-4a92-80a0-0d1d5cf0db0a",//设备id,用于识别设备
    "type":0,
    "data":{
        "cmd":3, //运行lua 指令为3
        "lua":"home();a =10;" //要执行的lua指令
        }
    }
1
2
3
4
5
6
7
8

# 停止辅助

  • 指令
{
    "deviceId":"c13bb8e2-96fc-4a92-80a0-0d1d5cf0db0a",//设备id,用于识别设备
    "type":0,
    "data":{
        "cmd":2 //停止指令 为2
        }
    }
1
2
3
4
5
6
7

# 获取截图

  • 指令
{
    "deviceId":"c13bb8e2-96fc-4a92-80a0-0d1d5cf0db0a",//设备id,用于识别设备
    "type":0,
    "data":{
        "cmd":4, //停止指令 为2
        "quirty":30,//压缩百分比 100%为无损,建议压缩,来提高传输速率
        "online":true,//是否返回外网http图片地址,fasle 则返回图片base64数据
        }
    }
1
2
3
4
5
6
7
8
9

-返回数据

{
    "data":{
        "img":"https://nscontrol.oss-cn-hangzhou.aliyuncs.com/ad2efc1e-4724-4c27-8192-69606c943098.jpg"
    },
    "deviceId":"c13bb8e2-96fc-4a92-80a0-0d1d5cf0db0a",
    "type":4,
    "userName":"240417809es"
}
1
2
3
4
5
6
7
8

# 中断连接

  • 指令
{
    "deviceId":"c13bb8e2-96fc-4a92-80a0-0d1d5cf0db0a",//设备id,用于识别设备
    "type":2
}
1
2
3
4