子用户

下面提供的链接指向一个页面,该页面详细介绍了我们系统内的“子用户”的概念。

子用户


请注意,几乎每个端点都与子用户相关,除了值得注意的 indexdelete 端点等例外情况外,将在成功调用时返回一个子用户资源。

SubuserResource
{
    "id": 5,
    "hash": "01HQ5K3P97DY8EX9Y90YT1K6XA",
    "username": "subuser_231",
    "password": "asffqwv2f3w4214v",
    "traffic_available": 0.25,
    "traffic_used": 0
}

当通过创建或更新的方式给子用户增加流量时,流量会从主账号中扣除。同样,当您删除子用户或从子用户中获取流量时,它将返回给主用户。


创建子用户

POST /residential-subusers

正文参数

名称
类型
描述

username

字符串

子用户的用户名

password

字符串

子用户的密码

traffic

浮点型

将分配给子用户的流量(GB)

limits

数组

可选参数,用于定义分配给子用户的限额。该结构可能由以下键值组成:daily_limit,monthly_limit,和/或 lifetime_limit。

請求範例

响应示例:

获取子用户

GET /residential-subusers/{ hash }

查询参数

名称
类型
描述

hash

字符串

子用户的哈希值

請求範例

响应示例:

获取多个子用户

GET /residential-subusers

查询参数

名称
类型
描述

page

整型

页码

per_page

整型

每页的子用户数

search

字符串

搜索将被用来筛选用户的用户名

請求範例

响应示例:

更新子用户

UPDATE /residential-subusers/{ hash }

查询参数

名称
类型
描述

哈希

字符串

子用户的哈希值

正文参数

名称
类型
描述

username

字符串

子用户的用户名

password

字符串

子用户的密码

traffic

浮点型

将分配给子用户的流量(GB)

limits

数组

可选参数,用于定义分配给子用户的限额。该结构可能由以下键值组成:daily_limit,monthly_limit,和/或 lifetime_limit。

請求範例

响应示例:

刪除子用戶

DELETE /residential-subusers/{ hash }

查询参数

名称
类型
描述

hash

字符串

子用户的哈希值

請求範例

新增流量至子使用者

POST /residential-subusers/{ hash }/give-traffic

查询参数

名称
类型
描述

hash

字符串

子用户的哈希值

正文参数

名称
类型
描述

amount

浮点型

给予的流量(GB)

請求範例

响应示例:

从子用户获取流量

POST /residential-subusers/{ hash }/take-traffic

查询参数

名称
类型
描述

hash

字符串

子用户的哈希值

正文参数

名称
类型
描述

浮点型

给予的流量(GB)

請求範例

响应示例:

Last updated