文档首页

爱快逆向 API - 认证服务 (1.0.0)

Download OpenAPI specification:

浏览器账密模式 /Action/call 逆向 API,当前分组:认证服务。

页面内真实调用仍然走 /Action/call/Action/call/_operations/* 只是 OpenAPI 展示用路径。

为避免 Redoc 单页一次性加载全部逆向接口导致浏览器 heap 过高,部署版按分类拆分。

会话

登录和会话建立

登录并建立浏览器 Cookie 会话

使用用户名和密码 MD5 登录。登录成功后,后续 /Action/call 依赖同一会话 Cookie。浏览器 API 可走 HTTP 或 HTTPS,实际是否允许 HTTP 取决于设备管理访问配置。

Request Body schema: application/json
required
username
required
string

登录用户名

passwd
required
string

密码 MD5 值

pass
required
string

密码 MD5 值,前端登录同时发送该字段

remember_password
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "username": "admin",
  • "passwd": "md5(password)",
  • "pass": "md5(password)",
  • "remember_password": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

通用调用

/Action/call 通用入口

通用 /Action/call 调用入口

所有页面内 API 调用都通过该路径提交 {func_name, action, param}。下方 /Action/call/_operations/* 路径是逐项文档展示路径,实际调用仍固定使用本路径。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string

爱快前端模块函数名

action
required
string

爱快前端动作名

required
object

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wan",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

PPPoE服务器管理API

来源分类: auth

获取PPPoE服务器配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/network/pppoe/services
  • 来源文件: auth/auth-pppoe.json
  • func_name: pppoe_server
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pppoe_server"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pppoe_server",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新PPPoE服务器配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/network/pppoe/services
  • 来源文件: auth/auth-pppoe.json
  • func_name: pppoe_server
  • action: save

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pppoe_server"

爱快前端模块函数名

action
required
string
Value: "save"

爱快前端动作名

required
object
Default: {"enabled":"no","server_name":"iKuai","force_verify_name":0,"server_ip":"10.1.1.1","dns1":"192.0.2.254","dns2":"192.0.2.254","authmode":0,"nas_identifier":"iKuai","nas_ip_address":"","radius_ip":"127.0.0.1","secret":"codex_Test_123","authport":1812,"accountport":1813,"addr_pool":"10.1.1.2-10.1.1.254","interface":"lan1","rate_limit_lan":1,"drop_client":1,"force_pppoe":0,"enhance_check":1,"share_deny":0,"bind_vlan":0,"verify_vlan":1,"bind_iface":0,"mtu":1480,"mru":1480,"lcp_echo_interval":10,"lcp_echo_failure":3,"maxconnect":0,"restart_timer":0,"restart_week":"","restart_time":""}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pppoe_server",
  • "action": "save",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

WEB认证服务管理API

来源分类: auth

获取WEB认证服务配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/auth/web/services
  • 来源文件: auth/auth-web-services.json
  • func_name: webauth
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "webauth"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,sync_interface,template"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "webauth",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

套餐管理API

来源分类: auth

获取套餐列表

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/auth/packages
  • 来源文件: auth/packages.json
  • func_name: ppp_package
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ppp_package"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ppp_package",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

添加套餐

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: POST /api/v4.0/auth/packages
  • 来源文件: auth/packages.json
  • func_name: ppp_package
  • action: add

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ppp_package"

爱快前端模块函数名

action
required
string
Value: "add"

爱快前端动作名

required
object
Default: {"packname":"基础套餐","packtime":"3m","price":100,"up_speed":500,"down_speed":1000,"comment":"codex_test"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ppp_package",
  • "action": "add",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

删除套餐

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: DELETE /api/v4.0/auth/packages/{id}
  • 来源文件: auth/packages.json
  • func_name: ppp_package
  • action: del

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ppp_package"

爱快前端模块函数名

action
required
string
Value: "del"

爱快前端动作名

required
object
Default: {"id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ppp_package",
  • "action": "del",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取指定套餐

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/auth/packages/{id}
  • 来源文件: auth/packages.json
  • func_name: ppp_package
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ppp_package"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ppp_package",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

修改套餐

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/auth/packages/{id}
  • 来源文件: auth/packages.json
  • func_name: ppp_package
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ppp_package"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"packname":"升级套餐","packtime":"6m","price":200,"up_speed":1000,"down_speed":2000,"comment":"codex_test","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ppp_package",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

用户账号管理API

来源分类: auth

获取用户账号列表

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/auth/users
  • 来源文件: auth/authusers.json
  • func_name: pppuser
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pppuser"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"total,data","limit":"0,500"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pppuser",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

添加用户账号

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: POST /api/v4.0/auth/users
  • 来源文件: auth/authusers.json
  • func_name: pppuser
  • action: add

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pppuser"

爱快前端模块函数名

action
required
string
Value: "add"

爱快前端动作名

required
object
Default: {"username":"codex_test_user","passwd":"codex_Test_123","enabled":"no","ppptype":"any","comment":"codex_test","expires":0,"start_time":1766483024,"share":1,"auto_mac":0,"upload":0,"download":0,"ip_type":0,"src_addr":{"custom":["10.10.1.1"]},"mac":"02:00:5e:99:99:99","address":"","name":"codex_test","phone":"","cardid":"","pppoev6_wan":"","packages":0,"bind_vlanid":"0","bind_ifname":"any","auto_vlanid":0}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pppuser",
  • "action": "add",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

删除用户账号

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: DELETE /api/v4.0/auth/users/{id}
  • 来源文件: auth/authusers.json
  • func_name: pppuser
  • action: del

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pppuser"

爱快前端模块函数名

action
required
string
Value: "del"

爱快前端动作名

required
object
Default: {"id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pppuser",
  • "action": "del",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取指定用户账号

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/auth/users/{id}
  • 来源文件: auth/authusers.json
  • func_name: pppuser
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pppuser"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"total,data","limit":"0,500","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pppuser",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

修改用户账号

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/auth/users/{id}
  • 来源文件: auth/authusers.json
  • func_name: pppuser
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pppuser"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"enabled":"no","comment":"codex_test","expires":0,"start_time":1766483024,"share":2,"auto_mac":0,"upload":100,"download":200,"ip_type":1,"src_addr":{"object":[{"gp_name":"000new11","type":0,"gid":"IPGP1"}]},"mac":"02:00:5e:99:99:99","address":"","name":"codex_test","phone":"","cardid":"","pppoev6_wan":"","packages":0,"bind_vlanid":"0","bind_ifname":"any","auto_vlanid":0,"id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pppuser",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

认证用户管理API

来源分类: auth

获取认证用户列表

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/auth/online-users
  • 来源文件: auth/online-users.json
  • func_name: ppp_online
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ppp_online"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ppp_online",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

断开认证用户

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: DELETE /api/v4.0/auth/online-users/{id}
  • 来源文件: auth/online-users.json
  • func_name: ppp_online
  • action: del

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ppp_online"

爱快前端模块函数名

action
required
string
Value: "del"

爱快前端动作名

required
object
Default: {"id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ppp_online",
  • "action": "del",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取指定认证用户

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/auth/online-users/{id}
  • 来源文件: auth/online-users.json
  • func_name: ppp_online
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示;调用设备时仍应 POST /Action/call,请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ppp_online"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ppp_online",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}