Name	Name	Last commit message	Last commit date
Latest commit History 80 Commits
README.md	README.md

魔豆路由器 HTTP API 规格文档

##目录

基本说明：

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

基础返回格式：

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

初始化向导设置

###检测wan口网线是否插入(无需鉴权) GET /api/guide/wan/check_wan_port_line_status

{
   "code"          :  0,   //  0为成功执行，其他为失败
   "msg"           : "",   // 执行失败时的返回错误原因
   "connected"    : true  //  true：网线插入， false：未插入
}

###检测互联网连通状态(无需鉴权) GET /api/guide/wan/is_internet_available

{
   "code"        : 0,    //检测外网是否可以连接到互联网 (0, 正常连接互联网;  1,正在测试中; 2, 不能正常连接; -1 执行失败;99,结果超时（此种情况需要上层重新调用此接口）)
   "msg"         : "",   // 执行失败时的返回错误原因
}

###检测wan口上网方式(无需鉴权) GET /api/guide/wan/check_internet_type

{
   "code"        : 0,      //  0为成功执行，
                            // -1 函数执行失败
                            // 1正在测试中
                            //99结果超时（此种情况需要上层重新调用此接口）
   "msg"           : "",   // 执行失败时的返回错误原因
   "mode"     	: 1       //  1：pppoe
                           //  2:dhcp
                           //  3:static
}

设置 WAN 口连接方式(无需鉴权)

POST /api/guide/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"
}

###快速设置无线名称和上网密码(无需鉴权) POST /api/guide/wifi/base_info_set

post data

{
  "ssid" : "your ssid", // 无线名称
  "password" : "your password" // 无线密码
}

response

{
   "code"        : 0,      //  0为成功执行，其他为失败
   "msg"     	: ""       // code非0时显示错误信息
}

###快速设置管理密码(无需鉴权) POST /api/guide/admin/admin_password_set

post data

{
  "password" : "your password" // 管理密码
}

response

{
   "code"        : 0,      //  0为成功执行，其他为失败
   "msg"     	: ""       // code非0时显示错误信息
}

取得 WiFi 的配置信息

GET /api/guide/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(0~1mw,4~2mw,7~5mw,10~10mw,13~13mw,16~39mw,19~79mw,20~100mw,22~158mw)
      "channel"           : 6,                      // 信道 Channel
      "net_type"          : 9,                      // 网络模式 WirelessMode (6,9,)
      "band_width_mode"   : 0,                      // 频道带宽 (0~自动，1~20HZ，2~40HZ)
      "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,                     // 网络模式 (14,15)
      "band_width_mode"   : 0,                      // 频道带宽 (0~自动，1~20HZ，2~40HZ，3~80HZ)
      "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，无线广播）
    }
}

重启

正常重启

GET /api/system/reboot

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

重启进安全模式

GET /api/system/safe_reboot

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

系统初始化完成时，请调用此api,否则用户不能上网。

GET /api/system/system_init_finished

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

获取系统状态信息

GET /api/system/get_info

{
  "code"          : 0,
  "cpu_used"       : 8,                   //cpu利用率8%
  "name"           : "QCA",
  "sn"              : "1111111111",
  "soft_version"    :"1.0",
  "hard_version"    :"2.0"
   "uptime"         : "22486",                // 路由器运行时间
}

获取内存和闪存信息

GET /api/devices/ddr2_flash

{
  "ddr2_total_size"          : 64,      //ddr总大小，单位kB
  "ddr2_remain"               : 28,     //ddr剩余大小，单位kB
  "flash_total_size"          :64,      //flash总大小，单位kB
  "flash_remain"              :28,      //flash剩余大小，单位KB
}

获取lan测主机列表

GET /api/devices/devices_all

{
  "code": 0,    //-1，函数失败; 0,成功获取;1,正在获取;99 结果超时
  "devices": [
    {
      "hostname"       : "android-a078b707872bc9a",   // 主机名
                                                        //unknown表示没有得到
      "ip"              : "192.168.1.11",              // ip地址
      "mac"             : "97:32:21:44:55:11:42",      // mac地址
      "leaseTime"        : "31223",                       //租约剩余时间单位(s)
                                                        //ip_mode=static时没有此选项
      "uptime"           : "8888888",                                   //客户端上线时间（单位s) “0”表示未获取
      "conn_type"        : "wire",               //客户端在那个接口下
                                                // wire: 有线
                                                //2G: 2g客户端
                                                //5G: 5g客户端
      "ip_mode"          : "static"               //获取IP地址类型
                                                //static:静态ip
                                                //dhcp:dhcp客户端
    },...
  ]
}

获取usb设备列表

GET /api/devices/usb_devices

{
  "code": 0,
  "devices": [
    {
      "interface"       : "usb3.0",   // 设备挂在那个接口下面：usb3.0 | usb2.0
       "format"         :"NTFS",     //usb设备格式 
                                        //NTFS
                                        //FAT32
                                        //FAT
                                        //EXFAT
                                        //unknown:未知格式
      "total_size"     :323233         //单位kB  
                                        // 0 获取失败
      "used_size"     :3233         //单位kB
                                    // 0 获取失败
      "name"          :"sda1"       //设备名称
      "label"         :"movie"      //设备卷标
                                    //unknown    没有得到卷标
    },...
  ]
}

删除usb设备

POST /api/devices/usb_remove_devices

post data

{
  "name" : "sda1" // 设备名为获取usb设备时的name字段
}

response

{
   "code"        : 0,      //  0为成功执行，其他为失败
                            // 2 未发现此设备
                            //3 设备忙，删除失败
   "msg"     	: ""       // code非0时显示错误信息
}

添加共享

POST /api/devices/share_add

post data

{
  "name" : "share_test" // 此选项为在电脑中看到的共享目录名字 
                        //注意，此为共享的关键字
                        //现阶段如果和已有的相同，那么最新的会生效，会覆盖掉原来的
  "path" : "/mnt/sda1/work" //要共享的文件路径                        
}

response

{
   "code"        : 0,      //  0为成功执行，其他为失败
                            //2 路径不存在
   "msg"     	: ""       // code非0时显示错误信息
}

删除共享

POST /api/devices/share_delete

post data

{
  "name" : "share_test" // 此选项为在电脑中看到的共享目录名字 
                      
}

response

{
   "code"        : 0,      //  0为成功执行，其他为失败  
                            // 2 不存在
   "msg"     	: ""       // code非0时显示错误信息
}

恢复出厂设置

GET /api/system/reset_config response

{
   "code"        : 0,      //  0为成功执行，其他为失败  
   "msg"     	: ""       // code非0时显示错误信息
}

WAN 口设置

###检测wan口网线是否插入 GET /api/wan/check_wan_port_line_status

{
   "code"          :  0,   //  0为成功执行，其他为失败
   "msg"           : "",   // 执行失败时的返回错误原因
   "connected"    : true  //  true：网线插入， false：未插入
}

获取当前 WAN 口设置

GET /api/wan/get_info

{
  "type"              : "STATIC",              // IP 地址获取的方式(DHCP, PPPOE, STATIC)
  "connect_type"      : "STATIC",              // 连接方式(DHCP, PPPOE, STATIC, AP_CLIENT)
  "ip"                : "192.168.1.13",
  "mask"              : "182.168.1.1",
  "gateway"           : "255.255.255.0",
  "dns1"              : "8.8.8.8",
  "dns2"              : "8.8.4.4",
  "mtu"               : 1500,
  "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"               : "00:00:ff:ff:ff:ff"    //wan 口mac
}

获取客户端 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
  "dhcp_advanced_enabled"   : true,                  // 是否开启dhcp高级设置
}

获取 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: 未知错误.
  "pppoe_advanced_enabled"   : true,                  // 是否开启pppoe高级设置
}

获取静态 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
"static_advanced_enabled"   : true,                  // 是否开启static高级设置
}

设置 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
}

备注 PPPOE提交参数:

{
"connect_type"          : "PPPOE",             // 连接方式(DHCP, PPPOE, STATIC, AP_CLIENT)
"type"                  : "PPPOE",             // IP 地址获取的方式(DHCP, PPPOE, STATIC)
"account"               : "account",            // 如果当前是PPPOE
"password"              : "password",           // 如果当前是PPPOE
  "pppoe_advanced_enabled"   : true,                  // 是否开启pppoe高级设置
}

DHCP提交参数:

{
"connect_type"          : "DHCP",             // 连接方式(DHCP, PPPOE, STATIC, AP_CLIENT)
"type"                  : "DHCP",             // IP 地址获取的方式(DHCP, PPPOE, STATIC)
"dhcp_advanced_enabled"   : true,                  // 是否开启dhcp高级设置
}

STATIC提交参数:

{
"connect_type"          : "STATIC",             // 连接方式(DHCP, PPPOE, STATIC, AP_CLIENT)
"type"                  : "STATIC",             // IP 地址获取的方式(DHCP, PPPOE, STATIC)
"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,
  "static_advanced_enabled"   : true,                  // 是否开启static高级设置
}

return data:

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

检测互联网连通状态

GET /api/wan/is_internet_available

{
   "code"        : 0,    //检测外网是否可以连接到互联网 (0, 正常连接互联网;  1,正在测试中; 2, 不能正常连接; -1 执行失败;99 结果超时 （此种情况需要上层重新调用此接口）)
   "msg"         : "",   // 执行失败时的返回错误原因
}

获取 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(0~1mw,4~2mw,7~5mw,10~10mw,13~13mw,16~39mw,19~79mw,20~100mw,22~158mw)
      "power_level"   : 1                      //wifi功率
                                                     //0 低 1 中 2 高
      "channel"           : 6,                      // 信道 Channel
      "net_type"          : 9,                      // 网络模式 WirelessMode (6,9,)
      "band_width_mode"   : 0,                      // 频道带宽 (0~自动，1~20HZ，2~40HZ)
      "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
      "mu_mimo_enabled"   : true,                //mu_mimo开关(true|fales)建议打开
      "beamforming_enabled"       : true,  //beamforming_enabled开关(true|fales)建议打开
      "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,                     // 无线信号功率
      "power_level"   : 1                      //wifi功率
                                                     //0 低 1 中 2 高
      "channel"           : 14,                     // 信道
      "net_type"          : 14,                     // 网络模式 (14,15)
      "band_width_mode"   : 0,                      // 频道带宽 (0~自动，1~20HZ，2~40HZ，3~80HZ)
      "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开关
     "mu_mimo_enabled"       : true,          //mu_mimo开关(true|fales)建议打开
     "beamforming_enabled"       : true,  //beamforming_enabled开关(true|fales)建议打开
      "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,           // 无线信号功率(0~1mw,4~2mw,7~5mw,10~10mw,13~13mw,16~39mw,19~79mw,20~100mw,22~158mw)
      "power_level"   : 1                      //wifi功率
                                                     //0 低 1 中 2 高
      "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,            // 网络模式 (6,9,)
                                          // 6: 11N only 强制11n, 11b,11g客户端连接不上
                                          // 9: 11BGN mixed

      "band_width_mode"   : 1,            // 频道带宽(0~自动，1~20HZ，2~40HZ) 
      "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)
      "mu_mimo_enabled"       : true          //mu_mimo开关 (true|fales) 建议打开
      "beamforming_enabled"       : true,  //beamforming_enabled开关(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)
       "power_level"   : 1                      //wifi功率
                                                     //0 低 1 中 2 高
      "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,           // 网络模式 (14,15)
                                          // 14: 11A/AN/AC mixed 5G band only
                                          // 15: 11ac only 强制802.11ac

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

取得访客WiFi 的配置信息

GET /api/wifi/get_config_guest

{
    "global":
    {
        "live_time"      : 5,                        //访客ssid存在时间
                                                    //单位分钟
                                                    //0表示一直存在
        "isolation_enabled":true                    //是否隔离此网络
                                                    //true 隔离网络，不能访问内部网，只能上外网
    },
  "2g":
    {
      "enabled"           : true,                   // 2.4g开关    RadioOff
      "ssid"              : "ssid1",                // 名称 SSID1(长度1-32字符)
     
      "security_mode"     : "WPAPSKWPA2PSK",        // Security Mode
      "encrypt"           : "TKIP",                 // WPA Algorithms(TKIP,AES ,TKIPAES)  EncrypType
      "password"          : "12345678"            // 密码 AuthMode（长度8-64字符）
    },
  "5g":
    {
      "enabled"           : true,                   // 5g开关
      "ssid"              : "ssid1",                // 名称
      "security_mode"     : "WPAPSKWPA2PSK"         // Security Mode
      "encrypt"           : "TKIP",                 // WPA Algorithms(TKIP,AES ,TKIPAES) EncrypType
      "password"          : "12345678",             // 密码
      "same_as_2g"        : true                    // 使用与2.4g相同的设置
    }
}

设置访客WiFi（非阻塞）

POST /api/wifi/set_config_guest

{
    "global":
    {
        "live_time"      : 5,                        //访客ssid存在时间
                                                    //单位分钟
                                                    //0表示一直存在
        "isolation_enabled":true                    //是否隔离此网络
                                                                    //true 隔离网络，不能访问内部网，只能上外网
    },
  "2g":
    {
      "enabled"           : true,                   // 2.4g开关    RadioOff
      "ssid"              : "ssid1",                // 名称 SSID1(长度1-32字符)
     
      "security_mode"     : "WPAPSKWPA2PSK",        // Security Mode
      "encrypt"           : "TKIP",                 // WPA Algorithms(TKIP,AES ,TKIPAES)  EncrypType
      "password"          : "12345678"            // 密码 AuthMode（长度8-64字符）
    },
  "5g":
    {
      "enabled"           : true,                   // 5g开关
      "ssid"              : "ssid1",                // 名称
      "security_mode"     : "WPAPSKWPA2PSK"         // Security Mode
      "encrypt"           : "TKIP",                 // WPA Algorithms(TKIP,AES ,TKIPAES) EncrypType
      "password"          : "12345678",             // 密码
      "same_as_2g"        : true                    // 与2.4g相同的设置
    }
}

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"                  : "12h",                            // 地址租期
  "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是否有连接
}

添加设备到wifi黑名单

POST /api/devices/wifi_blacklist/add

{
  "mac"					  : "A0:18:28:80:18:65,11:22:33:44:55:66" //设备物理地址,多个地址以逗号分隔
}

return data:

{
  "code":	0	//0表示操作成功，其他表示失败
}

将设备从wifi黑名单移除

POST /api/devices/wifi_blacklist/remove

{
  "mac"					  : "A0:18:28:80:18:65" //设备物理地址
}

return data:

{
  "code":	0	//0表示操作成功，其他表示失败
}

获取wifi黑名单

GET /api/devices/wifi_blacklist/get_list

{
  "devList":
	[
		{
			"mac"		:"A0:18:28:80:18:65",
			"hostName"	:"chendondeiPhone"
		},
		{	"mac"		:"7C:C5:37:4D:A9:49",
			"hostName"	:"ceshi-iPhone4"
		},
		...
	],
  "code":0 	//0表示操作成功，其他表示失败
}

添加设备到wifi白名单

POST /api/devices/wifi_whitelist/add

{
  "mac"					  : "A0:18:28:80:18:65,11:22:33:44:55:66" //设备物理地址,多个地址以逗号分隔
}

return data:

{
  "code":	0	//0表示操作成功，其他表示失败
}

将设备从wifi白名单移除

POST /api/devices/wifi_whitelist/remove

{
  "mac"					  : "A0:18:28:80:18:65" //设备物理地址
}

return data:

{
  "code":	0	//0表示操作成功，其他表示失败
}

获取wifi白名单

GET /api/devices/wifi_whitelist/get_list

{
  "devList":
	[
		{
			"mac"		:"A0:18:28:80:18:65",
			"hostName"	:"chendondeiPhone"
		},
		{	"mac"		:"7C:C5:37:4D:A9:49",
			"hostName"	:"ceshi-iPhone4"
		},
		...
	],
  "code":0 	//0表示操作成功，其他表示失败
}

设置wifi接入控制策略

POST /api/devices/wifi_acl/set_policy

{
  "policy":n 	//n=0:disalbe ACL check, n=1: whitelist mode, n=2: blacklist mode, n=3: flush ACL list, n=4: suspend current ACL policies. 
		    	//经过测试n=0和n=4实际效果一致，君请随意
}

return data:

{
  "code":	0	//0表示操作成功，其他表示失败
}

获取wifi接入控制策略

GET /api/devices/wifi_acl/get_policy

{
  "code": 0     //0表示操作成功，其他表示失败
  "policy":n 	//n值含义见set_policy接口
}

web端手动固件升级

POST /api/system/manual_upgrade

formdata contains: filename, filesize(bytes), and the rom file xxx.img.

在线升级--检测更新

GET /api/system/online_upgrade/check_update

return data:详见OTA接口文档

在线升级--开始下载

GET /api/system/online_upgrade/start_download

return data:

{
    "code": 0,                    //0表示操作成功，后台已经开始下载，其他表示失败
    "msg": "操作失败提示信息"   //操作成功时无此项
}

在线升级--检测下载进度

GET /api/system/online_upgrade/check_download

return data:

{
    "code": 0, 
    "percent":0.18 //下载进度百分比，以两位小数表示，范围: 0.00-1.00
}

在线升级--取消下载

GET /api/system/online_upgrade/cancel_download

return data:

{
    "code": 0
}

在线升级--开始更新

GET /api/system/online_upgrade/start_update

return data:

{
    "code": 0,                   //0表示操作成功，其他表示失败
    "msg": "操作失败提示信息"   //操作成功时无此项
}

设置设备的速度限制（仅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,					//kbit
    "down"  : 500					//kbit
}

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
        },
        ......
    ],
}

获取终端上下行实时速率

POST /api/qos/realtime_rate

postdata:

{
    "clients":
        [
            "192.168.18.105",
            "192.168.18.140",
            ...
        ]
}

return data:

{
    "code": 0
    "clients":
        [
            {
                "ip":"192.168.18.105",
                "upload_rate":100,      //unit: bytes/s
                "download_rate":999
            }
            ...
        ]
}

modouwifi/doc-modouwifi-api-v2

Folders and files

Latest commit

History

Repository files navigation

魔豆路由器 HTTP API 规格文档

基本说明：

初始化向导设置

设置 WAN 口连接方式(无需鉴权)

取得 WiFi 的配置信息

登录

修改密码

重启

正常重启

重启进安全模式

系统初始化完成时，请调用此api,否则用户不能上网。

获取系统状态信息

获取内存和闪存信息

获取lan测主机列表

获取usb设备列表

删除usb设备

添加共享

删除共享

恢复出厂设置

WAN 口设置

获取当前 WAN 口设置

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

获取dhcp设置

获取 PPPoE 设置

获取静态 IP 设置

设置 WAN 口连接方式

检测互联网连通状态

获取 WAN 口自定义的DNS

设置 WAN 口自定义DNS

WiFi 设置

取得 WiFi 的配置信息

设置 WiFi（非阻塞）

取得 访客WiFi 的配置信息

设置 访客WiFi（非阻塞）

无线网络是否已打开

请求打开wps

LAN 口

获取 LAN 口设置

修改 LAN 口设置

获取物理连接情况

添加设备到wifi黑名单

将设备从wifi黑名单移除

获取wifi黑名单

添加设备到wifi白名单

将设备从wifi白名单移除

获取wifi白名单

设置wifi接入控制策略

获取wifi接入控制策略

web端手动固件升级

在线升级--检测更新

在线升级--开始下载

在线升级--检测下载进度

在线升级--取消下载

在线升级--开始更新

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

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

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

获取终端上下行实时速率

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

取得访客WiFi 的配置信息

设置访客WiFi（非阻塞）

Packages