SmartProxy OpenAPI 文档

代理账户列表

GET

/pub/whitelist-account/list

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"id": 0,
				"username": "string",
				"password": "string",
				"created_at": "string",
				"remark": "string",
				"product_type": 9,
				"usage_flow": 0,
				"limit_flow": 102400,
				"status": 0
			}
		]
	}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	responseCode	false	none	状态码,200 成功、3 app_key 无效
» msg	string	false	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	账户编号
»»» username	string	false	none	代理账户名
»»» password	string	false	none	代理账户密码
»»» created_at	string	false	none	添加时间
»»» remark	string	false	none	备注
»»» product_type	productTypes	false	none	套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP
»»» usage_flow	integer	false	none	已使用流量，单位：KB
»»» limit_flow	integer	false	none	自定义流量上限：单位GB最大102400，0 不限制
»»» status	integer	false	none	启用状态：1启用，0停用

枚举值

属性	值
product_type	9
product_type	11
product_type	14
product_type	25

添加代理账户

POST

/pub/whitelist-account/add

Body 请求参数

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01:pass,user02:pass,user03:pass",
	"remark": "",
	"product_type": 9
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» app_key	body	string	否	授权密钥
» accounts	body	string	否	账户密码，请按格式 username:password 填写，账户和密码仅支持数字和字母，禁止输入任何特殊符号或空格,冒号隔开账户和密码。支持批量添加，英文逗号（,）分隔代理账户。
» remark	body	string	否	代理账户描述
» product_type	body	productTypes	否	套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP

枚举值

属性	值
» product_type	9
» product_type	11
» product_type	14
» product_type	25

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

删除代理账户

POST

/pub/whitelist-account/delete

请注意删除后无法恢复，已使用流量等无法查询。删除约有5分钟等待时间，在此期间仍可能产生费用。

Body 请求参数

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» app_key	body	string	否	授权密钥
» accounts	body	string	否	代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

禁用代理账户

POST

/pub/whitelist-account/disable

禁用约有5分钟等待时间，在此期间仍可能产生费用。

Body 请求参数

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» app_key	body	string	否	授权密钥
» accounts	body	string	否	代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

启用代理账户

POST

/pub/whitelist-account/enable

Body 请求参数

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» app_key	body	string	否	授权密钥
» accounts	body	string	否	代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

修改代理账户密码

POST

/pub/whitelist-account/change-password

请注意修改后有5分钟等待时间，在此期间旧密码仍可能正常使用。

Body 请求参数

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"password": "pass"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» app_key	body	string	否	授权密钥
» account	body	string	否	代理账户，仅支持数字和字母。
» password	body	string	否	代理账户新密码，仅支持数字和字母。

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

修改代理账户备注

POST

/pub/whitelist-account/change-remark

Body 请求参数

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"remark": ""
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» app_key	body	string	否	授权密钥
» account	body	string	否	代理账户，仅支持数字和字母。
» remark	body	string	否	代理账户新备注，32个中文或64个英文以内。

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

修改代理账户流量上限

POST

/pub/whitelist-account/change-limit

请注意流量统计可能有5分钟以内延迟，即实际消耗流量可能超过此限制。

Body 请求参数

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"limit": 0
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» app_key	body	string	否	授权密钥
» account	body	string	否	代理账户，仅支持数字和字母。
» limit	body	integer	否	流量限制，单位：GB，0为不设上限

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none