ProxyLite OpenAPI

app_key 认证密钥请登录后在个人中心首页查看。

请安全保存密钥，密钥拥有您的账户管理员权限。

Base URLs:

https://api.proxylite.com

认证方式

App Key 认证

POST 参数：

app_key: {your_app_key}

或作为查询参数：

?app_key={your_app_key}

响应格式

所有接口返回统一的 JSON 格式：

{
	"code": 200,
	"message": "操作成功",
	"data": {}
}

code: 状态码，200 表示成功，其他值表示失败
message: 响应消息（中文）
data: 响应数据

Authentication

本接口支持以下两种鉴权方式：

1. Bearer Token（JWT）

通过 HTTP Header 传递 Token。

Header 示例：

Authorization: Bearer <your_jwt_token>

API Key 鉴权

本接口采用 API Key 方式进行身份验证。

客户端需要在请求中携带 app_key 参数，否则请求将被拒绝。

示例：

GET /api/example?app_key=your_app_key

POST /api/example?app_key=your_app_key
Content-Type: application/json

代理账户管理

GET 代理账户列表

GET /end-point/whitelist-account/list

返回示例

成功响应（200）

{
	"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 添加代理账户

POST /end-point/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 删除代理账户

POST /end-point/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 禁用代理账户

POST /end-point/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 启用代理账户

POST /end-point/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 修改代理账户密码

POST /end-point/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 修改代理账户备注

POST /end-point/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 修改代理账户流量上限

POST /end-point/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

流量日志查询

GET 使用流量按天汇总

GET /end-point/user-usage-flow/total

请求参数

名称	位置	类型	必选	说明
app_key	query	string(password)	是	认证密钥
start_time	query	string(Y-m-d H:i:s)	否	起始时间，可精确到秒。请注意，日志记录有 5 分钟以内延迟。默认 7 天以内。
end_time	query	string(Y-m-d H:i:s)	否	截止时间，可精确到秒。请注意，日志记录有 5 分钟以内延迟。默认当前时间。
username	query	string	否	子账户名称,默认查询所有账户，可指定子账户。请注意如果您添加了相同名称的子账户，此查询将返回同名代理账户的所有使用记录。
product_type	query	number	否	套餐类型

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"day": "2022-08-01",
				"flow": 0
			}
		]
	}
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	none
»»» day	string	false	none	日期
»»» flow	integer	false	none	消耗流量,单位 KB

套餐查询

GET 已购套餐列表

GET /end-point/user-product/list

请求参数

名称	位置	类型	必选	说明
app_key	query	string(password)	是	认证密钥
trade_no	query	string	否	订单号，请输入完整订单号。不支持模糊搜索。
page	query	number	否	分页，默认：1
size	query	number	否	分页显示数量,默认：20
product_type	query	number	否	套餐类型

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"id": 0,
				"created_at": "2022-05-13 12:14:15",
				"expired_at": "2022-05-13 12:14:15",
				"product_type": 9,
				"trade_no": "2022051312134339861461465434",
				"order": {
					"created_at": "2022-05-13 12:13:43",
					"pay_at": "2022-05-13 12:13:43",
					"title": "入门级"
				}
			}
		],
		"page": 1,
		"page_size": 20,
		"total_count": 0,
		"total_page": 0
	}
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	套餐编号
»»» created_at	string	false	none	套餐生效时间
»»» expired_at	string	false	none	套餐过期时间,过期后流量无法使用。
»»» product_type	productTypes	false	none	套餐类型，9 动态住宅流量套餐、11 动态住宅 IP、14 静态数据中心 IP、25 静态住宅 IP
»»» trade_no	string	false	none	订单交易号
»»» order	object	false	none	none
»»»» created_at	string	false	none	订单创建时间
»»»» pay_at	string	false	none	订单支付时间
»»»» title	string	false	none	订单描述
»» page	integer	false	none	当前分页
»» page_size	integer	false	none	分页大小
»» total_count	integer	false	none	总记录数量
»» total_page	integer	false	none	总分页数量

枚举值

属性	值
product_type	9
product_type	11
product_type	14
product_type	25

IP 提取

GET 提取 IP

GET /end-point/ip/v3

请求参数

名称	位置	类型	必选	说明
app_key	query	string(password)	否	访问密钥
cc	query	string	否	国家或地区
state	query	string	否	省或州
city	query	string	否	城市
format	query	string	否	获取格式
lb	query	string	否	间隔符，仅 text 格式有效
num	query	number	否	提取数量
life	query	number	否	保持周期-分钟
ep	query	string	否	代理网络

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			[
				"150.109.114.72:1140",
				"150.109.114.72:1141",
				"150.109.114.72:1142",
				"150.109.114.72:1143",
				"150.109.114.72:1144",
				"150.109.114.72:1145",
				"150.109.114.72:1146",
				"150.109.114.72:1147",
				"150.109.114.72:1148",
				"150.109.114.72:1149"
			]
		]
	}
}

返回结果

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

返回数据结构

状态码 200

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

GET 城市列表

GET /end-point/ip/dynamic-citys

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "美国",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"city": null,
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	列表
»»» name_zh_cn	string	false	none	国家或地区名称
»»» name_en	string	false	none	国家或地区名称
»»» continent_code	string	false	none	大洲代码
»»» country_code	string	false	none	国家或地区代码
»»» items	[object]	false	none	省或州
»»»» city	string	false	none	城市名称
»»»» state	string	false	none	省或州名称代码
»»»» continent_code	string	false	none	大洲代码
»»»» country_code	string	false	none	国家或地区代码

GET 城市搜索

GET /end-point/ip/dynamic-citys/search

请求参数

名称	位置	类型	必选	说明
country_code	query	string	是	国家或地区代码
state	query	string	是	州或省代码

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

返回结果

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

返回数据结构

状态码 200

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

GET 州列表

GET /end-point/ip/dynamic-states

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "美国",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	列表
»»» name_zh_cn	string	false	none	国家或地区名称
»»» name_en	string	false	none	国家或地区名称
»»» continent_code	string	false	none	大洲代码
»»» country_code	string	false	none	国家或地区代码
»»» items	[object]	false	none	省或州
»»»» state	string	false	none	省或州名称代码
»»»» continent_code	string	false	none	大洲代码
»»»» country_code	string	false	none	国家或地区代码

GET 州/省搜索

GET /end-point/ip/dynamic-states/search

请求参数

名称	位置	类型	必选	说明
country_code	query	string	是	国家或地区代码

返回示例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

返回结果

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

返回数据结构

状态码 200

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

GET 提取已购买静态IP列表

GET /end-point/ip/get-static-ip

请求参数

名称	位置	类型	必选	说明
country_code	query	string	否	国家或地区代码
product_type	query	number	否	产品类型, 25:静态住宅 IP, 14: 数据中心 IP
trade_no	query	string	否	通过订单号筛选 IP
page	query	number	否	页码
size	query	number	否	每页数量
status	query	number	否	状态, 1:有效, 2:无效, 3:即将过期, 4:维护中

枚举值

属性	值
product_type	14
product_type	25
status	1
status	2
status	3
status	4

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET 获取在售地区静态IP数量

GET /end-point/static-ip-region

请求参数

名称	位置	类型	必选	说明
isp	query	string	否	IP类型

IP类型说明

IP类型	描述
1	家庭住宅静态IP
0	数据中心静态IP

返回示例

200 Response

{
	"code": 200,
	"msg": "请求成功",
	"data": {
		"list": [
			{
				"code": "US",
				"number": 55
			}
		]
	}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功
» msg	string	false	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	none
»»» code	string	false	none	国家或地区代码
»»» number	integer	false	none	数量

订单管理

GET 订单列表

GET /end-point/order/list

请求参数

名称	位置	类型	必选	说明
page_no	query	integer	否	none
page_size	query	integer	否	none
trade_no	query	string	否	订单编号
status	query	integer	否	订单状态
product_type	query	integer	否	产品类型

详细说明

status: 订单状态

状态	描述
0	待支付
1	已支付
2	超时未支付已取消
3	已退款

product_type: 产品类型

产品类型	描述
3	余额充值
9	动态流量套餐
11	动态全球包时套餐V2
12	长效IDC流量套餐
13	住宅静态IP流量套餐
14	数据中心静态IP套餐
15	长效ISP流量套餐
16	静态流量套餐
17	动态IP数量套餐
18	web-scraper
19	静态IP续费
20	静态IP更换配额
21	静态流量套餐v2
24	静态流量附加包套餐
25	住宅静态IP套餐
26	补单 - 部分支付渠道需要用户手动填写金额，如：虚拟币，若发生短款，需要联系客服通过此种产品进行补支付
27	Serp
28	Video

枚举值

属性	值
status	0
status	1
status	2
status	3
product_type	3
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	17
product_type	18
product_type	19
product_type	21
product_type	24
product_type	25
product_type	26
product_type	27
product_type	28

返回示例

200 Response

{
	"code": 0,
	"message": "操作成功",
	"data": {
		"list": [
			{
				"id": 0,
				"trade_no": "string",
				"product_id": 0,
				"product_name": "string",
				"total_fee": 0.1,
				"pay_fee": 0.1,
				"status": 0,
				"created_at": "2019-08-24T14:15:22Z"
			}
		],
		"pagination": {
			"total": 0,
			"page_no": 0,
			"page_size": 0,
			"total_pages": 0
		}
	}
}

返回结果

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

返回数据结构

POST 创建订单

POST /end-point/order/create

因套餐种类较多，且每种套餐存在不同的配置，请根据实际情况填写参数。不正当填写参数可能导致订单创建失败。

examples:

续费静态IP

{
    "pid": x, // 联系客服获取
    "upids": "1,2,3,4,5,6", // 从 /end-point/ip/get-static-ip 获取对应的ID
    "pm_id": 1 // 从 /end-point/payment/list 获取
    "coupon_sn: "xxx", // 可选 优惠券
  }

Body 请求参数

{
	"pid": 0,
	"upids": "string",
	"amount": 0,
	"pm_id": 0,
	"region_list": "string",
	"coupon_sn": "string",
	"use_invitation_registration_discount": true,
	"renew_duration": 0,
	"product_sku_bandwidth_id": 0,
	"product_sku_concurrency_id": 0,
	"recharge_amount": 0
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» pid	body	integer	是	套餐ID
» upids	body	string	否	续费套餐ID列表
» amount	body	number	否	新购套餐数量
» pm_id	body	integer	是	支付方式ID
» region_list	body	string	否	购买静态IP时指定区域+数量
» coupon_sn	body	string	否	优惠券编号
» use_invitation_registration_discount	body	boolean	否	是否使用邀请注册优惠
» renew_duration	body	integer	否	续费时长-静态IP可选
» product_sku_bandwidth_id	body	integer	否	套餐11：带宽套餐ID
» product_sku_concurrency_id	body	integer	否	套餐11：并发套餐ID
» recharge_amount	body	integer	否	套餐3：充值金额

返回示例

200 Response

{
	"code": 0,
	"message": "操作成功",
	"data": {
		"id": 0,
		"trade_no": "string",
		"product_id": 0,
		"product_name": "string",
		"total_fee": 0.1,
		"pay_fee": 0.1,
		"status": 0,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

返回结果

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

返回数据结构

POST 取消订单

POST /end-point/order/close

Body 请求参数

{
	"trade_no": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» trade_no	body	string	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

用户管理

GET 获取用户信息 - 暂未开放

GET /end-point/user/info

返回示例

200 Response

{
	"code": 0,
	"message": "操作成功",
	"data": {
		"id": 0,
		"email": "[email protected]",
		"phone": "string",
		"balance": 0.1,
		"status": 0,
		"is_real_name": true,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

返回结果

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

返回数据结构

支付管理

GET 获取支付方式列表

GET /end-point/payment/groups

请求参数

名称	位置	类型	必选	说明
trade_no	query	string	否	订单号 - 部分订单需要获取特定支付方式时可传入

返回示例

200 Response

{
	"code": 0,
	"message": "操作成功",
	"data": {
		"list": [
			{
				"name": "支付方式分组",
				"logos": ["https://example.com/logo1.png", "https://example.com/logo2.png"],
				"items": [
					{
						"id": 1,
						"title": "title1",
						"logo": "https://example.com/logo1.png",
						"group": "online",
						"disabled": false,
						"min": 10,
						"max": 5000
					}
				]
			}
		]
	}
}

返回结果

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

返回数据结构

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	object	false	none	none
»» name	string	false	none	分组名称
»» logos	string[]	false	none	分组图标列表
»» items	object[]	false	none	分组内项目列表
»»» id	integer	false	none	支付方式 ID
»»» title	string	false	none	支付方式名称
»»» logo	string	false	none	支付方式 Logo
»»» group	string	false	none	支付方式分组标识
»»» disabled	boolean	false	none	是否禁用（默认 `false`）
»»» min	number	false	none	最小金额
»»» max	number	false	none	最大金额

营销

GET 充值赠金比例

GET /end-point/activity/balance-recharge-gift-ratio

充值赠金比例

返回示例

200 Response

{
	"code": 0,
	"msg": "操作成功",
	"data": {
		"list": [
			{
				"amount": 100,
				"ratio": 1.2
			}
		]
	}
}

返回结果

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

返回数据结构

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	object	false	none	none
» list	[object]	false	none	none
»» amount	integer	false	none	充值金额
»» ratio	number	false	none	充值比例

数据结构说明（Schemas）

productTypes（套餐类型）

字段	类型	说明
product_type	integer	套餐类型

可选值说明：

值	含义
9	动态住宅流量套餐
11	动态住宅 IP
14	静态数据中心 IP
25	静态住宅 IP

API Key（认证密钥）

用于接口身份认证，请通过 Query 参数传递。

参数名	位置	类型	必填	说明
app_key	query	string	是	认证密钥

通用响应字段

responseCode

字段	类型	示例	说明
code	integer	200	状态码（200 成功，3 表示 app_key 无效）

responseMsg

字段	类型	示例	说明
message	string	success	响应信息

成功响应（SuccessResponse）

{
	"code": 0,
	"message": "操作成功",
	"data": {}
}

错误响应（ErrorResponse）

{
	"code": 400,
	"message": "参数错误",
	"errors": {}
}

User

{
	"id": 0,
	"email": "[email protected]",
	"phone": "string",
	"balance": 0.1,
	"status": 0,
	"is_real_name": true,
	"created_at": "2019-08-24T14:15:22Z"
}

名称	类型	必选	约束	说明
id	integer	false	none	none
email	string(email)	false	none	none
phone	string	false	none	none
balance	number(float)	false	none	none
status	integer	false	none	none
is_real_name	boolean	false	none	none
created_at	string(date-time)	false	none	none

Order

{
	"id": 0,
	"trade_no": "string",
	"product_id": 0,
	"product_name": "string",
	"total_fee": 0.1,
	"pay_fee": 0.1,
	"status": 0,
	"created_at": "2019-08-24T14:15:22Z"
}

名称	类型	必选	约束	说明
id	integer	false	none	none
trade_no	string	false	none	none
product_id	integer	false	none	none
product_name	string	false	none	none
total_fee	number(float)	false	none	none
pay_fee	number(float)	false	none	none
status	integer	false	none	none
created_at	string(date-time)	false	none	none

Product

{
	"id": 0,
	"name": "string",
	"type": 0,
	"price": 0.1,
	"description": "string"
}

名称	类型	必选	约束	说明
id	integer	false	none	none
name	string	false	none	none
type	integer	false	none	none
price	number(float)	false	none	none
description	string	false	none	none

WhiteIp

{
	"id": 0,
	"ip": "string",
	"remark": "string",
	"created_at": "2019-08-24T14:15:22Z"
}

名称	类型	必选	约束	说明
id	integer	false	none	none
ip	string	false	none	none
remark	string	false	none	none
created_at	string(date-time)	false	none	none

WhitelistAccount

{
	"id": 0,
	"username": "string",
	"limit": 0,
	"used": 0,
	"status": 0
}

名称	类型	必选	约束	说明
id	integer	false	none	none
username	string	false	none	none
limit	integer	false	none	none
used	integer	false	none	none
status	integer	false	none	none

Coupon

{
	"id": 0,
	"name": "string",
	"code": "string",
	"discount": 0.1,
	"expire_time": "2019-08-24T14:15:22Z"
}

名称	类型	必选	约束	说明
id	integer	false	none	none
name	string	false	none	none
code	string	false	none	none
discount	number(float)	false	none	none
expire_time	string(date-time)	false	none	none

Article

{
	"id": 0,
	"title": "string",
	"content": "string",
	"created_at": "2019-08-24T14:15:22Z"
}

名称	类型	必选	约束	说明
id	integer	false	none	none
title	string	false	none	none
content	string	false	none	none
created_at	string(date-time)	false	none	none

Pagination

{
	"total": 0,
	"page_no": 0,
	"page_size": 0,
	"total_pages": 0
}

名称	类型	必选	约束	说明
total	integer	false	none	none
page_no	integer	false	none	none
page_size	integer	false	none	none
total_pages	integer	false	none	none