Path: /public/api/v3/rmtctl/commandresult/{uid}
Method: GET
Description of interface
Return the latest 50 command results
Path Parameter
Name | Sample | Desc |
---|---|---|
uid |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object | Not Required | |||
├─ results | object [] | Not Required | item Type: object | ||
├─ id | string | Required | |||
├─ cmd | string | Required | |||
├─ publishAt | number | Required | |||
├─ updateAt | number | Required | |||
├─ result | string | Required | |||
msg | string | Not Required |
Path: /public/api/v3/rmtctl/commands/{uid}
Method: GET
Description of interface
Return the current commands which published in server side, and the got commands will be cleard in server side
Path Parameter
Name | Sample | Desc |
---|---|---|
uid | android_id |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object | Not Required | |||
├─ commands | object [] | Not Required | item Type: object | ||
├─ id | string | Required | |||
├─ cmd | string | Required | |||
msg | string | Not Required |
Path: /api/v2/proxy/specifyproxies
Method: POST
Description of interface
Get the proxies by specified proxy type, the authString in the proxoy item includes both username and passowrd, it is splited throgh 【:】
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
Names | string [] | Not Required | device Ids | item Type: string | |
├─ | Not Required | device Id |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object [] | Not Required | item Type: object | ||
├─ id | string | Required | Empty if the device is offline | ||
├─ tunnelType | string | Required | http/socks5 | ||
├─ addr | string | Required | |||
├─ authString | string | Required | |||
├─ connCount | number | Required | |||
├─ traffic_in | number | Required | |||
├─ traffic_out | number | Required | |||
├─ cur_conns | number | Required | |||
├─ updateAt | string | Required | last online time | ||
├─ port | string | Required | |||
├─ name | string | Required | device id | ||
├─ action | string | Required | |||
├─ rules | object,null | Required | |||
├─ status | string | Required | online/offline | ||
├─ clientip | string | Required | |||
├─ clientloc | string | Required | |||
├─ userId | string | Required | |||
├─ externalInfo | string | Required | |||
├─ isp | string | Required | |||
├─ ipInfo | string | Required | |||
├─ BytesLimited | string | Required | |||
├─ LimitPeriod | string | Required | |||
msg | string | Not Required |
Path: /public/api/v3/rmtctl/commands/{uid}
Method: POST
Description of interface
Publich command to device, it only works for rooted android currentlly.
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
uid |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
commands | object [] | Not Required | item Type: object | ||
├─ id | string | Required | |||
├─ cmd | string | Required |
Name | Type | Required | Default | Description | Others |
---|
Path: /public/api/v3/rmtctl/commandresult/{uid}
Method: POST
Description of interface
Push command execution result in remote device.
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
uid | android_id |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
results | object [] | Not Required | item Type: object | ||
├─ id | string | Required | |||
├─ result | string | Required |
Name | Type | Required | Default | Description | Others |
---|
Path: /
Method: GET
Description of interface
ClientName menas the device uniqueId, it is androidId in androidOS, or machineId in Linux/Windows.
Each device may have 1 or 2 proxies (http/socks5 proxy).
Name | Type | Required | Default | Description | Others |
---|
Path: /public/api/v3/rmtctl/resetbyport/{port}
Method: GET
Description of interface
Path Parameter
Name | Sample | Desc |
---|---|---|
port |
Path: /api/v2/proxy/editauth_byname/{deviceid}
Method: POST
Description of interface
Update proxy authenticatoin
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
deviceid | client-name-http:3f2bbeceef888d11 | client-name-{proxyType}:[deviceUniqueId] |
Body
Name | Type | Required | Sample | Desc |
---|---|---|---|---|
pwd | text | YES | a1 | password |
username | text | YES | b1 | username |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
authString | string | Not Required | |||
updateAt | string | Not Required |
Path: /public/api/v3/proxy/resetip/{userName}/{sessionId}
Method: POST
Description of interface
Clease specified session to make the ip changes for this session
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
userName | superpoert subuser name | |
sessionId | sessionid |
Name | Type | Required | Default | Description | Others |
---|
Path: /api/v2/serverinfo
Method: GET
Description of interface
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | Is normal response | ||
data | object | Not Required | |||
├─ version | string | Not Required | Version | ||
├─ tunnelAddr | string | Not Required | 代理端连接地址/TunnelAddress | ||
├─ apiAddr | string | Not Required | webConsole地址/webConsoleAddress | ||
├─ adminAddr | string | Not Required | 暂时忽略/Ignoreit | ||
├─ total_traffic_in | number | Not Required | 网络入口流量/Network traffic In | ||
├─ total_traffic_out | number | Not Required | 网络出口流量/Net work traffic out | ||
├─ proxy_provider_counts | number | Not Required | 代理客户端总数量 | ||
├─ proxy_customer_counts | number | Not Required | 当前连接总数量/Total connections currectlly | ||
├─ proxy_type_count | null | Not Required | 暂时忽略/ignore | ||
msg | string | Not Required | The message if server is not normal response |
Path: /api/v2/proxy/{proxyType}
Method: GET
Description of interface
Get the proxies by specified proxy type, the authString in the proxoy item includes both username and passowrd, it is splited throgh 【:】
Path Parameter
Name | Sample | Desc |
---|---|---|
proxyType | http | ValidValue, [http][socks5] |
Query
Name | Required | Sample | Desc |
---|---|---|---|
page | NO | 1 | for paging |
size | NO | 10 | for paging |
isp | NO | Digi | search by ISP |
loc | NO | India | search by Location |
addr | NO | 30912 | serach by proxy address |
root | NO | rooted | Valid value:[rooted,not,all] |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object | Not Required | |||
├─ proxies | object [] | Not Required | item Type: object | ||
├─ id | string | Required | for internal use | ||
├─ name | string | Not Required | uniqueId | ||
├─ addr | string | Not Required | proxy address | ||
├─ authString | string | Not Required | proxy authentication info | ||
├─ connCount | number | Not Required | Amount of conns | ||
├─ traffic_in | number | Not Required | |||
├─ traffic_out | number | Not Required | |||
├─ userId | string | Not Required | |||
├─ externalInfo | string | Not Required | device info, json formated string | ||
msg | string | Not Required |
Path: /api/v2/proxy/resetauth/{proxyId}
Method: POST
Description of interface
Reset the proxy auth info
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
proxyId | 代理id |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
authString | string | Not Required | |||
updateAt | string | Not Required |
Path: /api/v2/proxy/clearauth/{proxyId}
Method: GET
Description of interface
Clear the proxy auth info
Path Parameter
Name | Sample | Desc |
---|---|---|
proxyId | ProxyId |
Name | Type | Required | Default | Description | Others |
---|
Path: /api/v2/settings/clientname/{clientName}
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
clientName | android_id |
Body
Name | Type | Required | Sample | Desc |
---|---|---|---|---|
action | text | YES | resetNetwork |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
msg | string | Not Required |
Path: /api/v2/settings/clientname/{clientName}
Method: GET
Description of interface
Path Parameter
Name | Sample | Desc |
---|---|---|
clientName | android_id |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object | Not Required | |||
├─ id | string | Not Required | 客户端id | ||
├─ action | string | Not Required | 当前action | ||
├─ clientName | string | Not Required | 等同于android_id | ||
msg | string | Not Required |
Path: /api/v2/settings/uid/{uid}
Method: POST
Description of interface
Update proxy 【action】 field
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
uid | 客户端id |
Body
Name | Type | Required | Sample | Desc |
---|---|---|---|---|
action | text | YES | resetNetwork |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
msg | string | Not Required |
Path: /api/v3/proxy/clientname/{clientname}
Method: GET
Description of interface
ClientName menas uniqueId, it is androidId in androidOS
Path Parameter
Name | Sample | Desc |
---|---|---|
clientname | e.g: androidId |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object [] | Not Required | item Type: object | ||
├─ id | string | Required | |||
├─ tunnelType | string | Required | |||
├─ addr | string | Required | |||
├─ authString | string | Required | |||
├─ connCount | number | Required | |||
├─ traffic_in | number | Required | |||
├─ traffic_out | number | Required | |||
├─ cur_conns | number | Required | |||
├─ updateAt | string | Required | |||
├─ last_start_time | string | Required | |||
├─ last_close_time | string | Required | |||
├─ port | string | Required | |||
├─ name | string | Required | |||
├─ action | string | Required | |||
├─ sites | string | Required | |||
├─ clientip | string | Required | |||
├─ clientloc | string | Required | |||
msg | string | Not Required |
Path: /api/v3/cache/ports/all
Method: GET
Description of interface
The response same as get proxies API
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object | Not Required | |||
├─ client-name-http:{uniqueId} | object | Not Required | |||
├─ Auth | string | Not Required | |||
├─ UpdateAt | string | Not Required | |||
├─ Url | string | Not Required | |||
├─ Sites | string | Not Required | |||
├─ ByteIn | number | Not Required | |||
├─ ByteOut | number | Not Required | |||
├─ Action | string | Not Required | |||
├─ Port | number | Not Required | |||
├─ TrafficPeriodStartAt | string | Not Required | |||
├─ BytesLimited | number | Not Required | |||
├─ TrafficPeriod | number | Not Required | |||
├─ UserId | string | Not Required | |||
├─ ExternalInfo | string | Not Required | device info with JSON format | ||
msg | string | Not Required |
Path: /api/v3/proxy/userid/{userId}
Method: GET
Description of interface
Get live allproxies which of userId
Path Parameter
Name | Sample | Desc |
---|---|---|
userId | userId |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object [] | Not Required | item Type: object | ||
├─ id | string | Not Required | internal use | ||
├─ tunnelType | string | Not Required | |||
├─ addr | string | Not Required | |||
├─ authString | string | Not Required | |||
├─ connCount | number | Not Required | |||
├─ traffic_in | number | Not Required | |||
├─ traffic_out | number | Not Required | |||
├─ cur_conns | number | Not Required | |||
├─ updateAt | string | Not Required | |||
├─ last_start_time | string | Not Required | |||
├─ last_close_time | string | Not Required | |||
├─ port | string | Not Required | |||
├─ name | string | Not Required | |||
├─ action | string | Not Required | |||
├─ sites | string | Not Required | |||
├─ clientip | string | Not Required | |||
├─ clientloc | string | Not Required | |||
├─ userId | string | Not Required | |||
├─ externalInfo | string | Not Required | |||
msg | string | Not Required |
Path: /api/v3/cache/ports/update/{uniqueId}
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
uniqueId | client-name-http:3f2bbeceef888d11 |
Body
Name | Type | Required | Sample | Desc |
---|---|---|---|---|
newPort | text | YES | 37206 | new Port |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | null | Not Required | |||
msg | string | Not Required |
Path: /api/v3/proxy/ip
Method: GET
Description of interface
Query
Name | Required | Sample | Desc |
---|---|---|---|
ip | YES | 1.2.3.4 | client ip |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object [] | Not Required | item Type: object | ||
├─ id | string | Not Required | |||
├─ tunnelType | string | Not Required | |||
├─ addr | string | Not Required | |||
├─ authString | string | Not Required | |||
├─ connCount | number | Not Required | |||
├─ traffic_in | number | Not Required | |||
├─ traffic_out | number | Not Required | |||
├─ cur_conns | number | Not Required | |||
├─ updateAt | string | Not Required | |||
├─ last_start_time | string | Not Required | |||
├─ last_close_time | string | Not Required | |||
├─ port | string | Not Required | |||
├─ name | string | Not Required | |||
├─ action | string | Not Required | |||
├─ sites | string | Not Required | |||
├─ urlOption | string | Not Required | |||
├─ checkValue | string | Not Required | |||
├─ clientip | string | Not Required | |||
├─ clientloc | string | Not Required | |||
├─ userId | string | Not Required | |||
├─ externalInfo | string | Not Required | |||
msg | string | Not Required |
Path: /api/v2/rules/clientname/{clientName}
Method: POST
Description of interface
Sample request:
{"urlOption":"whitelist","urlSites":"www.speedtest.net","urlCheckValue":"host","ipOption":"whitelist","ipLimiters":"1.2.3.4\n10.1.1.1/24","nwSpeed":"0","nwconcurrentConn":"0","BytesLimited":"0","LimitPeriod":""}
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
clientName | ClientName menas uniqueId, it is androidId in androidOS |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
urlOption | string | Not Required | |||
urlSites | string | Not Required | |||
urlCheckValue | string | Not Required | |||
ipOption | string | Not Required | |||
ipLimiters | string | Not Required | |||
nwSpeed | string | Not Required | |||
nwconcurrentConn | string | Not Required | |||
BytesLimited | string | Not Required | |||
LimitPeriod | string | Not Required |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | null | Not Required | |||
msg | string | Not Required |
Path: /token/api/v1/user/add
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
name | string | Not Required | |||
password | string | Not Required | |||
concurrencyCount | number | Not Required | |||
allowedPorts | string [] | Not Required | item Type: string | ||
├─ | Not Required | ||||
ByteIn | number | Not Required | |||
ByteOut | number | Not Required | |||
traffTotal | number | Not Required | |||
allowedPortsStr | string | Not Required |
Name | Type | Required | Default | Description | Others |
---|
Path: /token/api/v1/user/del/{userName}/{reseller}
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
userName | user1 | |
reseller | reseller | It is optional. |
Path: /token/api/v1/user/edit
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
name | string | Not Required | |||
password | string | Not Required | |||
allowedPorts | string [] | Not Required | item Type: string | ||
├─ | Not Required | ||||
traffic | object | Not Required | |||
├─ ByteIn | number | Not Required | |||
├─ ByteOut | number | Not Required | |||
├─ TrafficLastUpdateAt | string | Not Required | |||
concurrencyCount | number | Not Required | |||
traffTotal | null | Not Required | |||
allowedPortsStr | string | Not Required |
Path: /api/v1/user/info/{userName}/{reseller}
Method: GET
Description of interface
Path Parameter
Name | Sample | Desc |
---|---|---|
userName | ||
reseller |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object | Not Required | |||
├─ user | object | Not Required | |||
├─ reseller | string | Not Required | |||
├─ name | string | Not Required | |||
├─ allowedPorts | null | Not Required | |||
├─ traffic | object | Not Required | |||
├─ ByteIn | number | Not Required | |||
├─ ByteOut | number | Not Required | |||
├─ transferLimit | number | Not Required | |||
├─ subscription | object | Not Required | |||
├─ bandwidth | number | Not Required | |||
msg | string | Not Required |
Path: /public/api/v3/proxy/clientname/{clientname}
Method: GET
Description of interface
ClientName menas uniqueId, it is androidId in androidOS
Path Parameter
Name | Sample | Desc |
---|---|---|
clientname | e.g: androidId |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object [] | Not Required | item Type: object | ||
├─ id | string | Required | |||
├─ tunnelType | string | Required | |||
├─ addr | string | Required | |||
├─ authString | string | Required | |||
├─ connCount | number | Required | |||
├─ traffic_in | number | Required | |||
├─ traffic_out | number | Required | |||
├─ cur_conns | number | Required | |||
├─ updateAt | string | Required | |||
├─ last_start_time | string | Required | |||
├─ last_close_time | string | Required | |||
├─ port | string | Required | |||
├─ name | string | Required | |||
├─ action | string | Required | |||
├─ sites | string | Required | |||
├─ clientip | string | Required | |||
├─ clientloc | string | Required | |||
msg | string | Not Required |
Path: /public/api/v3/rmtctl/reset/{deviceId}
Method: POST
Description of interface
It just works for rooted android
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
deviceId |
Name | Type | Required | Default | Description | Others |
---|
Path: /b
Method: GET
Description of interface
There are two ways to to do api authenticatoin, let assuems that we want to access our API http://1.2.3.4/v1/api/anything
1. Basic authentication
you can use http://user:pwd@1.2.3.4/v1/api/anything to access it
2. Token based
a. Login with /api/login, then you can get a token
b. add http header XSRF-TOKEN: YOUR TOKEN in the request
Path: /api/login
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | YES |
Body
Name | Type | Required | Sample | Desc |
---|---|---|---|---|
password | text | YES | pwd | |
username | text | YES | user |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
isAdmin | boolean | Not Required | |||
viewDevices | boolean | Not Required | |||
token | string | Not Required |
Path: /token/api/v1/reseller/add
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
name | string | Required | |||
password | string | Required | |||
concurrencyCount | number | Required | |||
allowedPorts | string [] | Required | item Type: string | ||
├─ | Not Required | ||||
ByteIn | number | Not Required | |||
ByteOut | number | Not Required | |||
traffTotal | number | Not Required | |||
allowedPortsStr | string | Not Required | |||
transferLimit | number | Required |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | string | Not Required | |||
msg | string | Not Required |
Path: /token/api/v1/reseller/del/{resellerName}
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
resellerName |
Body
Name | Type | Required | Default | Description | Others |
---|
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | string | Not Required | |||
msg | string | Not Required |
Path: /token/api/v1/reseller/query
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
page | number | Not Required | |||
size | number | Not Required | |||
name | string | Not Required |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object | Not Required | |||
├─ users | object [] | Not Required | item Type: object | ||
├─ name | string | Not Required | |||
├─ password | string | Not Required | |||
├─ traffic | object | Not Required | |||
├─ ByteIn | number | Not Required | |||
├─ ByteOut | number | Not Required | |||
├─ TrafficLastUpdateAt | string | Not Required | |||
├─ Status | string | Not Required | |||
├─ PendingAt | string | Not Required | |||
├─ CurrentStartedAt | string | Not Required | |||
├─ allowedPorts | string [] | Not Required | item Type: string | ||
├─ | Not Required | ||||
├─ concurrencyCount | number | Not Required | |||
├─ usedCount | number | Not Required | |||
├─ transferLimit | number | Not Required | |||
├─ subscription | object | Not Required | |||
├─ createdAt | string | Not Required | |||
├─ period | string | Not Required | |||
├─ bandwidth | number | Not Required | |||
├─ total | number | Not Required | |||
msg | string | Not Required |
Path: /token/api/v1/reseller/edit
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
name | string | Required | |||
password | string | Required | |||
concurrencyCount | number | Required | |||
allowedPorts | string [] | Required | item Type: string | ||
├─ | Not Required | ||||
ByteIn | number | Not Required | |||
ByteOut | number | Not Required | |||
traffTotal | number | Not Required | |||
allowedPortsStr | string | Not Required | |||
transferLimit | number | Required |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | string | Not Required | |||
msg | string | Not Required |
Path: /token/api/v1/userPlan/add
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
name | string | Not Required | |||
reseller | string | Not Required | |||
transferLimit | number | Not Required |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | string | Not Required | |||
msg | string | Not Required |
Path: /token//api/v1/userPlan/del/{planId}
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
planId |
Query
Name | Required | Sample | Desc |
---|---|---|---|
planId | YES |
Body
Name | Type | Required | Default | Description | Others |
---|
Name | Type | Required | Default | Description | Others |
---|
Path: /token/api/v1/userPlan/edit
Method: POST
Description of interface
{"ok":true,"data":"success","msg":""}
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Body
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
planId | string | Not Required | |||
name | string | Not Required | |||
reseller | string | Not Required | |||
transferLimit | number | Not Required |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | string | Not Required | |||
msg | string | Not Required |
Path: /token/api/v1/userPlan/query/{UserName}/{ResellerName}
Method: POST
Description of interface
Headers
Name | Value | Required | Sample | Desc |
---|---|---|---|---|
Content-Type | application/json | YES |
Path Parameter
Name | Sample | Desc |
---|---|---|
UserName | ||
ResellerName |
Name | Type | Required | Default | Description | Others |
---|---|---|---|---|---|
ok | boolean | Not Required | |||
data | object | Not Required | |||
├─ userPlans | object [] | Not Required | item Type: object | ||
├─ planId | string | Required | |||
├─ name | string | Required | |||
├─ reseller | string | Required | |||
├─ status | string | Required | |||
├─ transferLimit | number | Required | |||
├─ createdAt | string | Required | |||
├─ total | number | Not Required | |||
msg | string | Not Required |