Skip to content

Latest commit

 

History

History
1859 lines (1490 loc) · 53.8 KB

README.md

File metadata and controls

1859 lines (1490 loc) · 53.8 KB
Raw

魔豆路由器 HTTP API 规格文档

基本说明

  • 系统操作处于锁的状态下返回 code=－1
  • 身份鉴权基于 cookies
  • 除非明确标出，所有 API 都需要进行身份鉴权
  • 在未登录状态下访问需要 auth 的 API 会返回 403 状态码
  • 单位：流量的单位（kbps），磁盘容量单位（MB），时间单位（s）
  • 所有 POST 的请求的返回值的格式都为 JSON

基础返回格式：

{
  "code"    : 0,                  // 返回代码，类型为数字，0为成功，其他失败
  "msg"     : "hello"             // 可能存在的出错消息
}

使用此 API 的产品、服务和工具列表

登录

不需要身份验证

POST /api/auth/login

{
  "password" : "your password"
}

版本升级OP版

获取当前版本信息

不需要身份验证

GET /api/system/get_version_info

{
  "track"     :    "inter",          // 当前版本线，分内部版、开发版和稳定版
  "version1"  :    "0.5.27_beta2",   // 当前固件版本
  "version2"  :    "m101a"           // 当前硬件版本
}

获取ota最新版本

GET /api/system/upgrade_get_latest_version

{
  “code": code,  //0 成功  1 无法获取
  "msg" : "success or failed", 
  "version": "0.7.06_beta2",
  "uri": "http://cdn.ota.imoguyun.com/info/inter_m101b_all_0.7.06_beta2.bin",
  "filelength": 16213267,
  "filemd5": "6a013a0f351560a4cc3dc7fe7230efd1",
  "releasenote": "releasenote"
}

升级接口中除了获取ota版本以外，其他接口都需要版本参数，因为可能存在连续推送版本的情况，所以带上版本参数可以升级流程更清晰

开始升级

POST /api/system/upgrade_start

post data: jsondata[version]

{
  "code" : code //0 成功开始,  1 : 升级正在进行中或者已经结束（不需要再次开始一次新的升级过程), 2, 没有足够的存储空间
  "msg" : "msg"
}

取得升级的进度

POST /api/system/upgrade_get_status post data: jsondata[version]

{
  "version" : "version", // 当前正在进行的版本升级的版本 (如果有的话)
  "stage" : stage,  //0:没有升级正在进行, 1:正在下载中, 2:正在检查md5, 3:正在升级（刷机), 4:升级已经结束（可能成功，可能失败)
  "code" : code, // -2: 还没开始,  -1 : 正在处理中, 0 : 处理成功,  1:处理失败         "stage和code是相关的，标志了某一个stage的return code"
  "need_upgrade" : need_upgrade, // 0：当时的状态不需要start_update(升级正在进行中，或者已经成功升级过版本）  1:需要start update(当前没有升级在进行中，并且刚结束的升级活动不是成功的状态）
  "percent" : percent, // 下载或者刷机的stage中的百分比
  "msg" : msg
}

取消升级

POST /api/system/upgrade_cancel post data: jsondata[version]

{
  "code" : code, //0 : 成功  1 : 缺少版本参数
  "msg" : msg
}

版本升级

获取当前版本信息

不需要身份验证

GET /api/system/get_version_info

{
  "track"     :    "inter",          // 当前版本线，分内部版、开发版和稳定版
  "version1"  :    "0.5.27_beta2",   // 当前固件版本
  "version2"  :    "m101a"           // 当前硬件版本
}

全自动下载新版本、升级新版本

GET /api/system/download_and_upgrade

该接口为集成接口，其直接返回的json格式和/api/system/download_version_upgrade相同。

调用者需要根据接口的返回状态，再结合下载、升级各子过程的状态检查接口，获知当前的操作状态。

参考:

/api/system/download_version_upgrade

/api/system/check_download_progress

/api/system/upgrade_version

/api/system/check_upgrade_progress

检查当前为下载中、升级中或升级结束

GET /api/system/check_upgrade_global_status

{
  "code"        : -1,     //-1->无状态， 1->下载中，2->升级中, 3->升级结束
  "msg"         : ""
}
状态码 消息 意义
-1 "donothing" 没有在升级
-2 "/data is not mounted" data分区没有挂载
-3 "fail to download json file" 配置文件下载失败
-4 "fail to decode json file" 配置文件解析失败
-5 "no newer release" 没有新版本
-6 "md5 check failed" 升级包校验出错
-7 "signature error" 升级包签名出错
-8 "hardware version not match" 升级包和硬件版本不匹配
1 "downloading" 正在下载
2 "upgrading" 正在升级
3 "upgrade done" 升级完成

检查是否有新版本

GET /api/system/check_remote_version_upgrade

{
  "code"        : 0,      // 0->有新版本，3->read json faild, 4->已经是最新版
  "msg"         : "",
  "	"           : [0-9]*,
  "filename"    : "***.bin",
  "version"     : "****",
  "releasenote" : "release note"
}

下载新固件

GET /api/system/download_version_upgrade

{
  "code"        : 0,
  "msg"         : "",
}

查看下载进度

POST /api/system/check_download_progress

post data:

jsondata[filename] jsondata[filesize]

return data:

{
  "code"      : 0,        // 0 -> success,
                          // 1-> running,
                          // 2->没有mount /data,
                          // 3->读取latestversion失败
                          // 4-> 解析json失败
                          // 5->存储空间不足
                          // 6-> 下载失败
                          // 7->md5校验失败
                          // 8->link创建失败
                          // 9->自动升级正在下载
                          // 10->正在升级中不能下载
                          // 11->更名失效
  "msg"       : "",
  "percent"   : "xx",
  "stage"     : 0            // (0->pre check, 1-> download, 2->post check)
}

取消下载

GET /api/system/cancel_download

{
  "code"        : 0|1,
  "msg"         : ""
}

进行版本升级

GET /api/system/upgrade_version

{
  "code"        : 0,  // 0|1(0,成功；１,失败)
  "msg"         : "" //
}

获取当前升级百分比

GET /api/system/check_upgrade_progress

{
  "code"     : 0|1|2,       //              0-> success,
                            //              2->faild, upgraded nothing, Error
                            //              3->faild, upgraded safe only, Error
                            //              4->faild, upgraded vm only, Error
                            //              5->faild, upgraded sys only, Error
                            //              6->faild, upgraded safe and vm, Error
                            //              7->faild, upgraded safe and sys, Error
                            //              8->faild. 自动下载正在进行
                            //              9->faild, 数字签名出错
                            //              -1->progress

  "percent"  : 10           // number 表示升级进度10% (0-100)
  "msg"      : "xx",
  "stage"    : 0            // (0->uboot, 1->check image, 2->safe, 3->vm, 4->sys, 5->sys check, -1->wait)
}

重启

正常重启

GET /api/system/reboot

{
  "code"          : 0,
  "msg"           : ""
}

重启进安全模式

GET /api/system/safe_reboot

{
  "code"          : 0,
  "msg"           : ""
}

恢复出厂设置

GET /api/system/reset_config

背光控制

锁定背光，保持常亮

GET /api/system/lock_backlight

解锁背光，停止保持

GET /api/system/release_backlight

唤醒背光

GET /api/system/wakeup_backlight

获取设备识别码

GET /api/system/get_ucode

{
  "ucode"     :    "0007B7"
}

防蹭网

获取防蹭网开启状态

GET /api/security/get_config

{
  "code"        : 0,
  "enabled"     : true            // 防蹭网是否开启
}

设置防蹭网开关

POST /api/security/set_config

{
  "enabled"     : true            // 是否开启防蹭网
}

请求上网权限

不需要身份验证

POST /api/security/request_permission

post data:

{
  "username"    : "aaa"            // 用户名字
}

检查上网权限

不需要身份验证

GET /api/security/check_permission

return :

{
  "code"        : 0,                   // 0 -> 允许上网，1->不允许上网,2->等待主人处理 -1 ->系统内部错误
}

WAN 口设置

获取当前 WAN 口设置

GET /api/wan/get_info

{
  "type"              : "STATIC",              // IP 地址获取的方式(DHCP, PPPOE, STATIC)
  "connect_type"      : "STATIC",              // 连接方式(DHCP, PPPOE, STATIC, AP_CLIENT)
  "ip"                : "192.168.1.12",
  "mask"              : "182.168.1.1",
  "gateway"           : "255.255.255.0",
  "dns1"              : "8.8.8.8",
  "dns2"              : "8.8.4.4",
  "mtu"               : 2,
  "mtu_negotiable"    : 0,                     // 如果当前是PPPOE，默认为协商模式: 0
  "stp"               : true,
  "account"           : "account",             // 如果当前是PPPOE
  "password"          : "password",            // 如果当前是PPPOE
  "macCloneEnabled"   : true,                  // 是否开启Macclone
  "macCloneMac"       : "40:6c:8f:2d:6c:3b",   // MAC CLONE mac
  "uptime"            : "22486"                // 路由器运行时间
}

获取客户端 MAC 地址（用于 MAC 地址克隆）

GET /api/wan/clientmacaddr

{
  "macaddr"   : "40:6C:8F:2D:6C:3A"
}

获取dhcp设置

GET /api/wan/get_info/dhcp

{
  "dns1"    : "8.8.8.8",
  "dns2"    : "8.8.4.4",
  "mtu"     : 2,
  "stp"     : true
}

获取 PPPoE 设置

GET /api/wan/get_info/pppoe

{
  "account"         : "account",
  "password"        : "password",
  "pppoe_method"    : "KeepAlive",    // 连接模式(KeepAlive, OnDemand, Manual)
  "pedial_period"   : 60,             // 连接断开xx秒后尝试重拨,单位(秒) 当前KeepAlive
  "idle_time"       : 5,              // 无流量时xx分钟后断开,单位(分) 当前OnDemand
  "status"          : 0               // -1: PPPoE暂时无状态；
                                      // 0: 连接已成功；
                                      // 1: 用户名／密码错误；
                                      // 2: 连接已断开;
                                      // 3: 不允许本帐户在此时间登录;
                                      // 4: 帐户已禁用;
                                      // 5: 密码已过期;
                                      // 6: 帐户没有远程访问权限;
                                      // 7: 未知错误.
}

获取静态 IP 设置

GET /api/wan/get_info/static

{
  "ip"              : "192.168.1.12",
  "mask"            : "255.255.255.0",
  "gateway"         : "182.168.1.1",
  "dns1"            : "8.8.8.8",
  "dns2"            : "8.8.4.4",
  "mtu"             : 2,
  "stp"             : true
}

获取 AP Client IP 信息

GET /api/wan/get_info/apclient?deviceAlias= // 2g, 5g

{
  "ip"              : "192.168.1.12",
  "mask"            : "255.255.255.0",
  "gateway"         : "182.168.1.1"",
}

设置 WAN 口连接方式

POST /api/wan/set_config

post data:

{
  "type"                  : "STATIC",             // IP 地址获取的方式(DHCP, PPPOE, STATIC)
  "connect_type"          : "STATIC",             // 连接方式(DHCP, PPPOE, STATIC, AP_CLIENT)
  "ip"                    : "192.168.1.12",
  "mask"                  : "255.255.255.0",
  "gateway"               : "192.168.1.1",
  "dns1"                  : "8.8.8.8",
  "dns2"                  : "8.8.4.4",
  "mtu"                   : 2,
  "stp"                   : true,
  "account"               : "account",            // 如果当前是PPPOE
  "password"              : "password",           // 如果当前是PPPOE
  "pppoe_method"          : "KeepAlive",          // 连接模式(KeepAlive, OnDemand, Manual)
  "pedial_period"         : 60,                   // 连接断开xx秒后尝试重拨,单位(秒) 当前KeepAlive
  "idle_time"             : 5,                    // 无流量时xx分钟后断开,单位(分) 当前OnDemand
  "macCloneEnabled"       : true,                 // 是否开启 Macclone
  "macCloneMac"           : "40:6c:8f:2d:6c:3b"   // MAC CLONE mac
}

return data:

{
  "code"  : 0,          // (0->设置成功，1-> 正在设置，-1 ->已有全局设置锁)
  "msg"   : "xx"
}

检测互联网连通状态

GET /api/wan/is_internet_available

{
  "code"    : 0    // 检测外网是否可以连接到互联网 (0, 正常连接互联网; 1, 不能正常连接; 
                                                    2, 解析域名失败; 3, 网路状况不佳, 比如下载导致的)
  "msg"     : "error message"   // 错误消息, 如果有的话.
}

获取 WAN 口上下行流量信息

GET /api/wan/get_traffics

{
  "up"          : number,               // 取得自系统启动以来，上行数据的总量(单位字节）
  "up_str"      : "number",             // up 值的字符串形式 例如: "12345678"
  "down"        : number                // 取得自系统启动依赖，下行数据的总量（单位字节）
  "down_str"    : "number"              // down 值的字符串形式 例如: "12345678"
  "code"        : 0,                    // 成功
  "tx_rate"     : 0,                    // 发丢包率
  "rx_dropped"  : 0,                    // 收丢包
  "rx_packets"  : 270649,               // 收包
  "tx_packets"  : 282499,               // 发包
  "rx_rate"     : 0,                    // 收丢包率
  "tx_dropped"  : 0                     // 发丢包
}

获取 WAN 口自定义的DNS

GET /api/wan/custom_dns/get

return:

{
  "code"        : 0,                    // 返回码，0正常，非0出错
  "dns1"        : "8.8.8.8",            // 自定义DNS1
  "dns2"        : "8.8.4.4"             // 自定义DNS2
}

设置 WAN 口自定义DNS

POST /api/wan/custom_dns/set

{
  "dns1"        : "8.8.8.8",            // 自定义DNS1
  "dns2"        : "8.8.4.4"             // 自定义DNS2
}

WiFi 设置

取得 WiFi 的配置信息

GET /api/wifi/get_config

{
  "2g":
    {
      "enabled"           : true,                   // 2.4g开关    RadioOff
      "ssid"              : "ssid1",                // 名称 SSID1(长度1-32字符)
      "broadcastssid"     : true,                   // 是否广播SSID
      "security_mode"     : "WPAPSKWPA2PSK",        // Security Mode
      "encrypt"           : "TKIP",                 // WPA Algorithms(TKIP,AES ,TKIPAES)  EncrypType
      "password"          : "12345678",             // 密码 AuthMode（长度8-64字符）
      "power"             : 20,                     // 无线信号功率	TXPower
      "channel"           : 6,                      // 信道 Channel
      "net_type"          : 9,                      // 网络模式 WirelessMode (0,1,4,6,9,)
      "band_width_mode"   : 1,                      // 频道带宽 HT_BW (0|1)
      "mac"               : "28-2c-b2-97-82-39",    // mac地址 命令行ifconfig
      "beacon"            : 40,                     // Beacon时槽 BeaconPeriod (20~1024)
      "apsd_enabled"      : true,                   // APSD开关 APSDCapable
      "ap_enabled"        : true,                   // AP隔离开关 NoForwarding
      "shortgi_enabled"   : true,                   // short GI开关 HT_GI
      "wmm_enabled"       : true                    // 多媒体优先WMM开关 WmmCapable
    },
  "5g":
    {
      "enabled"           : true,                   // 5g开关
      "ssid"              : "ssid1",                // 名称
      "broadcastssid"     : true,                   // 是否广播SSID
      "security_mode"     : "WPAPSKWPA2PSK"         // Security Mode
      "encrypt"           : "TKIP",                 // WPA Algorithms(TKIP,AES ,TKIPAES) EncrypType
      "password"          : "12345678",             // 密码
      "power"             : 20,                     // 无线信号功率
      "channel"           : 14,                     // 信道
      "net_type"          : 14,                     // 网络模式 (2,8,14,15)
      "band_width_mode"   : 1,                      // 频道带宽 (0|1)
      "mac"               : "28-2c-b2-97-82-39",    // MAC 地址
      "beacon"            : 40,                     // Beacon 时槽
      "apsd_enabled"      : true,                   // APSD 开关
      "ap_enabled"        : true,                   // AP隔离开关
      "shortgi_enabled"   : true,                   // short GI 开关
      "wmm_enabled"       : true,                   // 多媒体优先WMM开关
      "same_as_2g"        : true                    // 使用与2.4g相同的设置
                                                    //（包含：无线名称，加密方式，加密算法，密码，传输功率，
                                                    // Beacon时槽，APSD，AP隔离，Short GI
                                                    // 多媒体优先WMM，无线广播）
    }
}

设置 WiFi（非阻塞）

POST /api/wifi/set_config

{
  "2g":
    {
      "enabled"           : true,         // 2.4g开关 (true|false)
      "ssid"              : "ssid1",      // 名称(长度1-32字符) (any string)
      "broadcastssid"     : true,         // 是否广播SSID
      "security_mode"     : "Disable",    // Security Mode (Disable,WPAPSK,WPA2PSK,WPAPSKWPA2PSK)
      "encrypt"           : "TKIP",       // WPA Algorithms EncrypType
                                          // (NONE<>Disable,   TKIP<>WPA(2)PSK,
                                          // AES<>WPA(2)PSK ,   TKIPAES<>WPA(2)PSK)
      "password"          : "12345678",   // 密码(长度8-64字符) (any string)
      "power"             : 20,           // 无线信号功率 (100,90,60,30,15,0)
      "channel"           : 0,            // 哪个信道 (0)
                                          // {'name': '自动选择', 'value': 0},
                                          // {'name': '2412MHz (Channel 1)', 'value': 1},
                                          // {'name': '2417MHz (Channel 2)', 'value': 2},
                                          // {'name': '2422MHz (Channel 3)', 'value': 3},
                                          // {'name': '2427MHz (Channel 4)', 'value': 4},
                                          // {'name': '2432MHz (Channel 5)', 'value': 5},
                                          // {'name': '2437MHz (Channel 6)', 'value': 6},
                                          // {'name': '2442MHz (Channel 7)', 'value': 7},
                                          // {'name': '2447MHz (Channel 8)', 'value': 8},
                                          // {'name': '2452MHz (Channel 9)', 'value': 9},
                                          // {'name': '2457MHz (Channel 10)', 'value': 10},
                                          // {'name': '2462MHz (Channel 11)', 'value': 11},
                                          // {'name': '2467MHz (Channel 12)', 'value': 12},
                                          // {'name': '2472MHz (Channel 13)', 'value': 13}

      "net_type"          : 9,            // 网络模式 (0,1,4,6,9,)
                                          // 2G: 9
                                          // 0: legacy 11b/g mixed
                                          // 1: legacy 11B only
                                          // 4: legacy 11G only
                                          // 6: 11N only
                                          // 9: 11BGN mixed

      "band_width_mode"   : 1,            // 频道带宽(20Mhz->0, 20Mhz/40Mhz->1,强制40Mhz->2)
      "beacon"            : 40,           // Beacon时槽 (20~1024)
      "apsd_enabled"      : true,         // APSD开关 (true|false)
      "ap_enabled"        : true,         // AP隔离开关 (true|false)
      "shortgi_enabled"   : true,         // short GI开关 (true|false)
      "wmm_enabled"       : true          // 多媒体优先WMM开关 (true|fales)
    },
  "5g":
    {
      "enabled"           : true,         // 5g开关
      "ssid"              : "ssid1",      // 名称(长度1-32字符)
      "broadcastssid"     : true,         // 是否广播SSID
      "security_mode"     : "Disable",    // Security Mode(Disable,WPAPSK,WPA2PSK,WPAPSKWPA2PSK)
      "encrypt"           : "TKIP",       // WPA Algorithms(TKIP,AES ,TKIPAES)
                                          // (NONE<>Disable, TKIP<>WPA(2)PSK,
                                          // AES<>WPA(2)PSK, TKIPAES<>WPA(2)PSK)
      "password"          : "12345678",   // 密码(长度8-64字符)
      "power"             : 20,           // 无线信号功率 (100,90,60,30,15,0)
      "channel"           : 0,            // 哪个信道
                                          // {'name': '自动选择', 'value': 0},
                                          // {'name': '5180MHz (Channel 36)', 'value': 36},
                                          // {'name': '5200MHz (Channel 40)', 'value': 40},
                                          // {'name': '5220MHz (Channel 44)', 'value': 44},
                                          // {'name': '5240MHz (Channel 48)', 'value': 48},
                                          // {'name': '5260MHz (Channel 52)', 'value': 52},
                                          // {'name': '5280MHz (Channel 56)', 'value': 56},
                                          // {'name': '5300MHz (Channel 60)', 'value': 60},
                                          // {'name': '5320MHz (Channel 64)', 'value': 64},
                                          // {'name': '5745MHz (Channel 149)', 'value': 149},
                                          // {'name': '5765MHz (Channel 153)', 'value': 153},
                                          // {'name': '5785MHz (Channel 157)', 'value': 157},
                                          // {'name': '5805MHz (Channel 161)', 'value': 161},
                                          // {'name': '5825MHz (Channel 165)', 'value': 165}


      "net_type"          : 14,           // 网络模式 (2,8,14,15)
                                          // 5G 14
                                          // 2: legacy 11A only
                                          // 8: 11AN mixed
                                          // 14: 11A/AN/AC mixed 5G band only
                                          // 15: 11 AN/AC mixed 5G band only

      "band_width_mode"   : 1,            // 频道带宽 (0|1)
      "beacon"            : 40,           // Beacon时槽
      "apsd_enabled"      : true,         // APSD开关
      "ap_enabled"        : true,         // AP隔离开关
      "shortgi_enabled"   : true,         // short GI开关
      "wmm_enabled"       : true,         // 多媒体优先WMM开关
      "same_as_2g"        : true          // 使用与2.4g相同的设置（包含：无线名称，加密方式，
                                          // 加密算法，密码，传输功率，Beacon时槽，APSD，AP隔离，
                                          // Short GI，多媒体优先WMM，无线广播）
    }
}

GET /api/wifi/check_set

{
  "code"                  : 0,            // (0->设置成功，1-> 正在设置，-1 ->已有全局设置锁)
  "msg"                   : "xx"
}

无线网络是否已打开

GET /api/wifi/is_enabled

{
  "is_enabled"            : bool,         // 是否已经打开了wifi
}

请求打开wps

GET /api/wifi/start_wps

{
  "code"            : 0,         // 0为成功，其他为失败
}

LAN 口

获取 LAN 口设置

GET /api/lan/get_lan_config

{
  "ip"                    : "192.168.1.2",                  // ip
  "net_mask"              : "255.255.255.0",                // 子网掩码
  "dhcp_enabled"          : true,                           // dhcp开关
  "ipaddr_start"          : "4.4.4.4",                      // IP地址开始段
  "ipaddr_end"            : "4.4.4.4",                      // IP地址结束段
  "gateway"               : "192.168.1.0",                  // 网关
  "dhcp_net_mask"         : "255.255.255.0",                // dhcp子网掩码
  "dns1Method"            : "手动",                         // dns1设置方式（手动，自动）
  "dns2Method"            : "自动",                         // dns2设置方式（手动，自动）
  "dns1"                  : "8.8.8.8",                      // 首选dns
  "dns2"                  : "",                             // 备用dns
  "time"                  : 381,                            // 地址租期
  "mac"                   : "28-2c-b2-97-82-39"             // mac地址
}

修改 LAN 口设置

POST /api/lan/set_lan_config

{
  "ip"                    : "192.168.1.2",                  // ip
  "net_mask"              : "255.255.255.0",                // 子网掩码
  "dhcp_enabled"          : true,                           // dhcp开关
  "ipaddr_start"          : "4.4.4.4",                      // IP地址开始段
  "ipaddr_end"            : "4.4.4.4",                      // IP地址结束段
  "gateway"               : "192.168.1.0",                  // 网关
  "dhcp_net_mask"         : "255.255.255.0",                // dhcp子网掩码
  "dns1Method"            : "手动",                         // dns1设置方式（手动，自动）
  "dns2Method"            : "自动",                         // dns2设置方式（手动，自动）
  "dns1"                  : "8.8.8.8",                      // 首选dns
  "dns2"                  : "",                             // 备用dns
  "time"                  : 381,                            // 地址租期
  "mac"                   : "28-2c-b2-97-82-39"             // mac地址
}

GET /api/lan/check_set

{
  "code"                  : 0,          // (0->设置成功，1-> 正在设置，2-> 设置失败)
  "msg"                   : "xx"
}

获取物理连接情况

GET /api/system/get_cable_connection

{
  "wan"                   : true,             // wan口是否有物理连接
  "lan1"                  : true,             // wan口是否有物理连接
  "lan2"                  : true,             // wan口是否有物理连接
  "usb"                   : true              // usb是否有连接
}

获取系统时间

GET /api/system/get_time

{
  "time"                  : 2361632818231,    // 路由器时间（单位秒）
  "time_type"             : 0|1               // 时间格式，0->12小时制式,1->24小时制式 (type:number)
}

设置系统时间

POST /api/system/set_time

post data:

{
  "time_type"             : 0|1               // 时间格式，0->12小时制式,1->24小时制式 (type:number)
}

外联设备

硬盘设备信息

GET /api/devices/disk

{
  "totalSize"         : 1,                  // 总大小(KB)
  "left"              : 0.23,               // 剩余空间(KB)
  "name"              : "disk1",            // 硬盘的名字
  "time"              : 5677                // 连接时间
}

卸载硬盘

GET /api/devices/disk_uninstall

{
  "code"              : 0,
  "msg"               : ""
}

获取内存和闪存信息

GET /api/devices/ddr2_flash

{
  "ddr2_total_size"     : 64,            // ddr2总大小（KB）
  "ddr2_remain"         : 28,            // ddr2剩余（KB）
  "flash_total_size"    : 64,            // flash总大小（KB）
  "flash_remain"        : 28,            // flash剩余（KB）
}

获取有线设备列表

GET /api/devices/cables

{
  "code": 0,
  "devices": [
    {
      "platform"        : "phone",                     // 设备类型(phone, pad, unknow)
      "total_speed"     : 200,                         // 总速率
      "down_speed"      : 100,                         // 下载速度
      "up_speed"        : 100,                         // 上传速度
      "host_name"       : "android-a078b707872bc9a",   // 主机名
      "connectType"     : "WIFI5G",                    // 连接类型c
      "up"              : "10MB",                      // 总上传
      "down"            : "10GB",                      // 总下载
      "type"            : 1,                           // 设备连接方式(1->cable, 2->wifi2.4g,3->wifi5g)
      "ip"              : "192.168.1.11",              // ip地址
      "mac"             : "97:32:21:44:55:11:42",      // mac地址
      "leftTime"        : 31223,                       // 租约剩余时间单位(s)
      "time"            : 31223,                       // 连接时间单位(s)
      "tag"             : "white"                      // 白名单，黑名单，或没有(white, black, "")
      "up_limit"        : 400,                         // 上传限速
      "down_limit"      : 600,                         // 下载限速
      "local"           : 0                            // 0 or 1, web使用, 是否是当前主机
    },...
  ]
}

获取无线设备列表

GET /api/devices/wifis

{
  "code": 0,
  "devices": [
    {
      "platform"      : "phone",                        // 设备类型(phone, pad, unknow)
      "total_speed"   : 200,                            // 总速率
      "down_speed"    : 100,                            // 下载速度
      "up_speed"      : 100,                            // 上传速度
      "host_name"     : "android-a078b707872bc9a",      // 主机名
      "connectType"   : "WIFI5G",                       // 连接类型
      "up"            : "10MB",                         // 总上传
      "down"          : "10GB",                         // 总下载
      "type"          : 1,                              // 设备连接方式(1->cable, 2->wifi2.4g,3->wifi5g)
      "ip"            : "192.168.1.11",                 // ip地址
      "mac"           : "97:32:21:44:55:11:42",         // mac地址
      "leftTime"      : 31223,                          // 租约剩余时间单位(s)
      "time"          : 31223,                          // 连接时间单位(s)
      "tag"           : "white",                        // 白名单，黑名单，或没有(white, black, "")
      "up_limit"      : 400,                            // 上传限速
      "down_limit"    : 600,                            // 下载限速
      "single"        : 100,                            // 信号强度
      "local"         : 0,                              // or 1, web使用, 是否是当前主机
      "rssi0"         : -30,                            // 信号强度
      "rssi1"         : 0,                              // 信号强度
      "rssi2"         : -50                             // 信号强度
    },...
  ]
}

修改设备主机名

POST /api/devices/edit_hostname

{
  "mac"               : "97:32:21:44:55:11:42",
  "host_name"         : "android-a078b"
}

获得黑名单列表

GET /api/devices/blacklist

{
  "devices":
    [
      {
        "platform"    : "phone",                        // 设备类型(phone, pad, unknow)
        "host_name"   : "android-a078b707872bc9a",      // 主机名
        "type"        : 1,                              // 设备连接方式(1->cable, 2->wifi2.4g,3->wifi5g)
        "mac"         : "97:32:21:44:55:11:42",         // mac地址
      },...
    ],
  "code": 0
}

获得白名单列表

GET /api/devices/whitelist

{
  "devices":
    [
      {
        "platform"    : "phone",                        // 设备类型(phone, pad, unknow)
        "host_name"   : "android-a078b707872bc9a",      // 主机名
        "type"        : 1,                              // 设备连接方式(1->cable, 2->wifi2.4g,3->wifi5g)
        "mac"         : "97:32:21:44:55:11:42",         // mac地址
      },...
    ],
  "code":0
}

获得灰名单列表（上网请求设备列表）

GET /api/devices/graylist

{
  "devices":
    [
      {
        "mac"         : "AA:BB:CC:DD:EE:FF",                 // 请求设备的MAC地址
        "ip"          : "192.168.10.100",                    // IP地址
        "username"    : "张三丰",                            // 用户名
      },...
    ],
  "code": 0
}

把设备添加到黑名单

POST /api/devices/blacklist_add

{
  "mac": "32:21:44:55:11:42"
}

从黑名单移除

POST /api/devices/blacklist_remove

{
  "mac": "32:21:44:55:11:42"
}

添加到白名单

POST /api/devices/whitelist_add

{
  "mac": "32:21:44:55:11:42"
}

从白名单移除

POST /api/devices/whitelist_remove

{
  "mac": "32:21:44:55:11:42"
}

应用防火墙规则

POST /api/devices/apply_rule

{
  "mac": "32:21:44:55:11:42"
}

极客模式相关接口

GET /api/system/get_expertMode

{
  "enabled": true/false
}

POST /api/system/set_expertMode

post data：

{
  "enabled": true/false
}

return data：

{
  "code"          : 0,
  "msg"           : "error message when failed",    // (optional, when error happens)
  "password"      : "XXXXXXX"                       // (optional, when expert mode is enabled)
}

应用管理

获取已安装应用的列表

GET /api/plugin/installed_plugins

return data:

{
  "code":0,                                       // 返回码, 0 成功，非0失败
  "plugins": [                                    // 应用列表
    {
      "id"            : "0000001",                // 应用的ID
      "name"          : "Hello,World",            // 应用的名字
      "author"        : "魔锤网络科技",           // 应用的作者
      "icon"          : "http://xxxxxx.png",      // 应用图标的链接
      "source"        : "http://xxxxx.tar.gz",    // 应用的安装包连接
      "version"       : "0.0.1",                  // 应用的最新版本
      "size"          : 12432,                    // 应用包的大小
      "chksum"        : "addeae87343573223",      // 应用包的校验码
      "releaseDate"   : "2014.06.20",             // 应用的发布日期
      "installDate"   : "2014.06.21",             // 应用的安装日期
      "description"   : "第一个Demo插件",         // 应用的说明
      "instruction"   : "1,xxx; 2,xxx"            // 应用的安装、使用说明
      "is_sys_app"    : 是否是内置应用            // 如果是内置系统应用，则不允许删除（可升级）
    }, ...
  ]
}

获取某应用的最新信息

GET /api/plugin/plugin_latest_info?id=0000001

return data:

{
  "code" : 0,                                     // 返回码, 0 成功，非0失败
  "info" :
    {
      "id"            : "0000001",                // 应用的ID
      "name"          : "Hello,World",            // 应用的名字
      "author"        : "魔锤网络科技",           // 应用的作者
      "icon"          : "http://xxxxxx.png",      // 应用图标的链接
      "source"        : "http://xxxxx.tar.gz",    // 应用的安装包连接
      "version"       : "0.0.1",                  // 应用的最新版本
      "size"          : 12432,                    // 应用包的大小
      "chksum"        : "addeae87343573223",      // 应用包的校验码
      "releaseDate"   : "2014.06.20",             // 应用的发布日期
      "description"   : "第一个Demo插件",         // 应用的说明
      "instruction"   : "1,xxx; 2,xxx"            // 应用的安装、使用说明
    }
}

安装应用

POST /api/plugin/install_plugin

post data:

{
  "name"        : "modou-samba"                   // 应用名称
}

return data:

{
    "code"    : 0,                                // 返回码, 0 成功，非0失败
    "msg"     : "",                               // 错误消息
    "id"      : "72428512"                        // 应用ID
}

删除应用

POST /api/plugin/uninstall_plugin

post data:

{
  "id"    : "0000001"                             // 应用ID
}

return data:

{
  "code"  : 0,                                    // 返回码, 0 成功，非0失败
  "msg"   : ""                                    // 错误消息
}

启动应用

POST /api/plugin/start_plugin

post data:

{
  "id"        : "0000001"                         // 应用ID
}

return data:

{
  "code"  : 0,                                    // 返回码, 0 成功，非0失败
  "msg"   : ""                                    // 错误消息
}

停止应用

POST /api/plugin/stop_plugin

post data:

{
  "id"        : "0000001"                         // 应用ID
}

return data:

{
  "code"      : 0,                                // 返回码, 0 成功，非0失败
  "msg"       : ""                                // 错误消息
}

查询应用状态

GET /api/plugin/plugin_status?id=0000001

{
  "code"      : 0,                                // 返回码, 0 成功，非0失败
  "msg"       : "",                               // 错误消息
  "id"        : "0000001",                        // 应用ID
  "isRunning" : true,                             // 是否正在运行
  "status"    : "xxxxxxxxxxx"                     // 附件状态信息
}

查询应用的安装状态

GET /api/plugin/plugin_install_status?id=0000001

{
  "code"      : 0,                                // 返回码, 0 成功，非0失败
  "msg"       : ""                                // 错误消息
}
状态码 消息 意义
-1 "plugin ID missing" 缺少应用ID
-2 "It's not installing plugin:<PLUGIN_ID>" 当前不在安装应用
1 "downloading plugin config file" 正在下载应用配置文件
2 "parsing plugin config file" 正在解析应用配置文件
3 "downloading the install package of plugin" 正在下载安装包
4 "checking md5 checksum of install package" 正在校验安装包
5 "installing plugin" 正在安装
6 "remove old app" 删除老应用
7 "updating installed plugin list" 更新已安装应用列表
8 "auto start app" 自动启动应用
0 "plugin successfully installed" 应用安装成功
10 "plugin alreay installed" 应用已安装
101 "failed to open status file:<FILENAME>" 读取状态失败
901 "failed to download the plugin config file" 下载配置文件失败
902 "failed to read plugin config file : <CODE>" 读取配置文件失败
903 "field missing in plugin config file" 配置文件错误
904 "failed to download plugin install package" 下载安装包失败
905 "MD5 check sum doesn't match with config" MD5校验失败
906 "extract the install package failed" 解压安装包失败

对应用进行配置

POST /api/plugin/config/set

POST /api/plugin/config (不建议使用)

post data:

{
  "package_id"  : "0000001",                  // 应用ID
  "data"        : <JSON OBJECT>               // 应用自行维护的JSON配置数据
}

return data:

{
  "code"      : 0,                            // 返回码, 0 成功，非0失败
  "msg"       : "",                           // 错误消息
  "data"      : <JSON OBJECT>                 // 应用自行维护的JSON配置数据
}

获取应用的配置信息

GET /api/plugin/config/get?id=<package_id>&type=<TP|MOBILE|WEB>

return data:

{
  "code"      : 0,                            // 返回码, 0 成功，非0失败
  "msg"       : "",                           // 错误消息
  "data"      : <JSON OBJECT>,                // 应用自行维护的JSON配置数据
  "views"     : <JSON OBJECT>,                // 应用的视图配置信息
  "actions"   : <JSON OBJECT>                 // 应用的命令列表
}

执行应用的某个操作

POST /api/plugin/execute

post data:

{
  "package_id"  : "0000001",                  // 应用ID
  "type"        : "TP|MOBILE|WEB",            // 调用来源类型
  "actions"     : <JSON OBJECT>               // 应用的命令列表
}

return data:

{
  "code"      : 0,                            // 返回码, 0 成功，非0失败
  "msg"       : "",                           // 错误消息
  "data"      : <JSON OBJECT>                 // 应用自行维护的JSON配置数据 
}

action的JSON数据格式:

{
    "command1" : {
      "id"      : "command1",                 // 应用的命令ID
      "is_sync" : true,                       // 是否需要同步阻塞执行,默认阻塞同步
      "input"   : "100"                       // 应用的命令参数
    }
}

data的JSON数据格式:

{
    "data1" : {
      "id"      : "data1",                    // 配置数据的ID
      "name"    : "username",                 // 配置数据的名字
      "value"   : "middle",                   // 配置数据的值
      "group_id": "group1",                   // 配置数据的组ID
      "type"    : {
                     "class" : "ENUM|BOOL|INT|STRING|FLOAT|SET",
                     "items" : ["high", "middle", "low"],  // ENUM，SET适用
                     "min"   : 0,                          // INT, FLOAT, STRING使用
                     "max"   : 100,                        // INT, FLOAT, STRING使用
                     "multiple" : true|false
                  }
    }
}

view的JSON数据格式:

{
    "view1" : {
      "id"      : "view1",                    // 配置视图的ID
      "name"    : "viewname",                 // 配置视图的名字
      "data"    : {
                    "data1" : {"id" : "data1",// 视图需要展示的数据的ID
                     "acess" : "RO|RW"        // 数据是否可修改
                    },
                    ...
                  },
      "menu"    : {                           // 主视图适用
                      "1" : { "index"  : 1, 
                        "text"   : "contract", 
                        "type"   : "COMMAND|MENU|VIEW",
                        "action" : actionid,  // COMMAND适用
                        "input"  : data1,     // COMMAND适用
                        "viewid" : viewid,    // VIEW适用
                        "items"  : {          // MENU适用
                                     "1" : {
                                        "index"  : 1,
                                        "text"   : "item1",
                                        "type"   : "COMMAND|VIEW",
                                        "action" : actionid, // COMMAND适用
                                        "input"  : data1,    // COMMAND适用
                                        "viewid" : viewid    // VIEW适用
                                     },
                                     ...
                                    }
                       },
                       ...
                   }
      
    }
}

安装非认证应用

POST /api/plugin/install_custom

post data:

{
  "name"      : "app-name",                   // 应用名称
  "file"      : "xxxxcvvadfafad",             // 安装包的内容
  "size"      :  10240                        // 文件的大小
}

return data:

{
  "code"      : 0,                            // 返回码, 0 成功，非0失败
  "id"        : "app-id",                     // 生成的应用ID
  "msg"       : ""                            // 错误消息
}

日志

上传日志

GET /api/logs/report 给路由器发送命令，上传日志

return data:

{
  "code"      : 0                             // 返回码, 0 成功，非0失败
}

Commands 命令，可以执行 shell 命令

执行 shell 命令

POST /api/commands/run

POST data:

{
  "cmd": "echo 'hello modou'"
}

return data:

{
  "code"      : 0                             // 返回码, 0 成功，非0失败
  "output"    : ""                            // shell 执行的结果
}

获取执行 shell 命令历史

GET /api/commands/history

return data:

{
  "code"      : 0                             // 返回码, 0 成功，非0失败
                                              // 执行的 shell 历史
  "cmds"      : [
    {
      "id"    : "12345678",
      "cmd"   : "echo modou"
    },
    ...
  ]
}

搜索热点信息

GET /api/apclient/survey?deviceAlias=5g /* 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) */

return data:

{
    "code"   : 0                // 0, 成功; -1, 失败
    "survey" : [
        {
            "channel"    :   "161",
            "ssid"       :   "Modou-1234",
            "bssid"      :   "24:de:c6:5a:19:d8", // MAC address
            "security"   :   "WPA1PSKWPA2PSK", // OPEN, WPAPSK, WPA2PSK, WPA1PSKWPA2PSK
            "encrypType" :   "TKIPAES",  // NONE, WEP, TKIP, AES, TKIPAES
            "signal"     :   "99",
            "w-Mode"     :   "11a/n"
        },
        ...
    ]
}

连接到 AP

POST /api/apclient/connectToAP

post data:

{
    /*2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) */
    "deviceAlias"    :  "5g", 
    "connectionInfo" :  {
        "channel"    :  "161",
        "ssid"       :  "modou-0a10",
        "bssid"      :  "24:de:c6:5a:19:d8", // MAC address
        "security"   :  "WPA1PSKWPA2PSK", // OPEN, WPAPSK, WPA2PSK, WPA1PSKWPA2PSK
        "encrypType" :  "TKIPAES",  // NONE, WEP, TKIP, AES, TKIPAES
        "password"   :  "12345678"  
    }
}

return data:

{
    "code"   : 0,                // 0, 成功; -1, 失败
    "msg"    : "Error Message" 
}

断开 AP Client 连接

/* 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) */ GET /api/apclient/disconnect?deviceAlias=5g

return data:

{
    "code"   : 0,                // 0, 成功; -1, 失败
    "msg"    : "Error Message" 
}

重新连接到 AP

/* 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) */ GET /api/apclient/reconnectToAP?deviceAlias=5g

return data:

{
    "code"   : 0,                // 0, 成功; -1, 失败
    "msg"    : "Error Message" 
}

使能 AP Client

/* 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) */ GET /api/apclient/eableAPClient?deviceAlias=5g

return data:

{
    "code"   : 0,                // 0, 成功; -1, 失败
    "msg"    : "Error Message" 
}

关闭 AP Client

/* 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) */ GET /api/apclient/disableAPClient?deviceAlias=5g

return data:

{
    "code"   : 0,                // 0, 成功; -1, 失败
    "msg"    : "Error Message" 
}

获取 AP Client 当前状态

/* 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) */ GET /api/apclient/apClientStatus?deviceAlias=5g

return data:

{
    "code"   : 0,                // 0, disable; 1, enable; -1, 获取状态失败
    "msg"    : "Error Message" 
}

获取上一次的连接信息

/* 2g, rt2860(ra0, 2.4G); 5g, mt7610/rtdev(raii0, 5G) */ GET /api/apclient/prevConnectionInfo?deviceAlias=5g

return data:

{
    "code"   : 0,                // 0, disable; 1, enable; -1, 获取状态失败
    "msg"    : "Error Message" 
}

测试连上路由器的速度

不需要身份验证

GET /api/speedtest?size=1024

size 以 KB 为单位

QoS设置

设定优先模式

POST /api/qos/set_mode

post data:

{
    "mode"  : "vip"              // 优先级模式, 暫支持none|vip|speedlimit|game
}

return data:

{
    "code"   : 0,                // 0, 成功; 非0失败
    "msg"    : "Error Message" 
}

查询优先模式

GET /api/qos/get_mode

return data:

{
    "code"   : 0,                // 0, 成功; 非0失败
    "mode"   : "vip"             // 优先级模式, none,vip,speedlimit
    "msg"    : "Error Message"   
}

开启/关闭智能QoS

POST /api/qos/set_smart

post data:

{
    "enable" :  true/false       // true，开启；false, 关闭
}

return data:

{
    "code"   : 0,                // 0, 成功; 非0失败
    "msg"    : "Error Message" 
}

获取智能QoS状态

GET /api/qos/get_smart

return data:

{
    "code"   : 0,                // 0, 成功; 非0失败
    "enabled":  true/false       // true，开启；false, 关闭
    "msg"    : "Error Message" 
}

设置设备的优先级（仅QoS为VIP优先模式时有效）

POST /api/qos/set_prio

post data:

{
    "ip"    : "192.168.18.123",     // 被设置优先级的设备的IP地址
    "mac"   : "11:22:33:44:55:66",  // 被设置优先级的设备的MAC地址
    "prio"  : 3                     // 优先级，数值小的优先级高;目前支持1,2,3
}

return data:

{
    "code"   : 0,                // 0, 成功; 非0失败
    "msg"    : "Error Message" 
}

删除设备的优先级（仅QoS为VIP优先模式时有效）

POST /api/qos/rm_prio

post data:

{
    "ip"    : "192.168.18.123",     // 被设置优先级的设备的IP地址
    "mac"   : "11:22:33:44:55:66",  // 被设置优先级的设备的MAC地址
    "prio"  : 3                     // 优先级，数值小的优先级高;目前支持1,2,3
}

return data:

{
    "code"   : 0,                // 0, 成功; 非0失败
    "msg"    : "Error Message" 
}

查询优先级配置（仅QoS为VIP优先模式时有效）

GET /api/qos/vip_config

return data:

{ "code" : 0,
  "conf" : [
    [
        {
            "ip"    : "192.168.18.121",     // 被设置优先级的设备的IP地址
            "mac"   : "11:22:33:44:55:61",  // 被设置优先级的设备的MAC地址
            "prio"  : 1                     // 优先级，数值小的优先级高;目前支持1,2,3
        },
        ......
    ],
    [
        {
            "ip"    : "192.168.18.122",     // 被设置优先级的设备的IP地址
            "mac"   : "11:22:33:44:55:62",  // 被设置优先级的设备的MAC地址
            "prio"  : 2                     // 优先级，数值小的优先级高;目前支持1,2,3
        },
        ......
    ],
    [
        {
            "ip"    : "192.168.18.123",     // 被设置优先级的设备的IP地址
            "mac"   : "11:22:33:44:55:63",  // 被设置优先级的设备的MAC地址
            "prio"  : 3                     // 优先级，数值小的优先级高;目前支持1,2,3
        },
        ......
    ] 
]}

设置设备的速度限制（仅QoS为speedlimit模式时有效）

POST /api/qos/set_bandwidth

post data:

{
    "ip"    : "192.168.18.123",     // 被设置优先级的设备的IP地址
    "mac"   : "11:22:33:44:55:66",  // 被设置优先级的设备的MAC地址
    "up"    : 100,
    "down"  : 500
}

return data:

{
    "code"   : 0,                // 0, 成功; 非0失败
    "msg"    : "Error Message" 
}

删除设备的速度限制（仅QoS为speedlimit模式时有效）

POST /api/qos/rm_bandwidth

post data:

{
    "ip"    : "192.168.18.123",     // 被设置优先级的设备的IP地址
    "mac"   : "11:22:33:44:55:66",  // 被设置优先级的设备的MAC地址
    "up"    : 100,
    "down"  : 500
}

return data:

{
    "code"   : 0,                // 0, 成功; 非0失败
    "msg"    : "Error Message" 
}

查询网速限制配置（仅QoS为speedlimit模式时有效）

GET /api/qos/bandwidth_config

return data:

{ "code" : 0,
  "conf" : [
    [
        {
            "ip"    : "192.168.18.121",     // 被限制设备的IP
            "mac"   : "11:22:33:44:55:61",  // 被限制设备的MAC, 可选
            "up"    : 100,                  // 上行带宽限制,单位 kbps
            "down"  : 500                   // 下行宽限制,单位 kbps
        },
        ......
    ],
    [
        {
            "ip"    : "192.168.18.121",     // 被限制设备的IP
            "mac"   : "11:22:33:44:55:61",  // 被限制设备的MAC, 可选
            "up"    : 100,                  // 上行带宽限制,单位 kbps
            "down"  : 500                   // 下行宽限制,单位 kbps
        },
        ......
    ],
    [
        {
            "ip"    : "192.168.18.121",     // 被限制设备的IP
            "mac"   : "11:22:33:44:55:61",  // 被限制设备的MAC, 可选
            "up"    : 100,                  // 上行带宽限制,单位 kbps
            "down"  : 500                   // 下行宽限制,单位 kbps
        },
        ......
    ] 
]}

截图

GET /api/screenshot

Response Data:

{
  "code": 0,                // 0, 成功; -1, 失败
  "url": "http://image.url"
}