ProxyLite OpenAPI
向下滚动查看代码示例、请求示例和响应示例。可从上方标签页或移动端导航菜单中选择代码示例语言。
app_key 认证密钥请登录后在个人中心首页查看。
请安全保存密钥，密钥拥有您的账户管理员权限。
认证方式
App Key 认证
POST 参数：
app_key: {your_app_key}
或作为查询参数：
?app_key={your_app_key}
响应格式
所有接口返回统一的 JSON 格式：
{
"code": 200,
"message": "操作成功",
"data": {}
}
code: 状态码，200 表示成功，其他值表示失败message: 响应消息（中文）data: 响应数据
Base URLs:
Authentication
- HTTP Authentication, scheme: bearer
- API Key (apiKeyAuth)
- Parameter Name: app_key, in: query. 支持GET/POST，name 支持
代理账户管理
代理账户列表
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/list?app_key=pa%24%24word \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/whitelist-account/list
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| app_key | query | string(password) | true | 认证密钥 |
响应示例
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停用 |
Enumerated Values
| 属性 | 值 |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
添加代理账户。
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/add \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/whitelist-account/add
Body parameter
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01:pass,user02:pass,user03:pass",
"remark": "",
"product_type": 9
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » app_key | body | string | false | 授权密钥 |
| » accounts | body | string | false | 账户密码，请按格式 username:password 填写，账户和密码仅支持数字和字母，禁止输入任何特殊符号或空格,冒号隔开账户和密码。支持批量添加，英文逗号（,）分隔代理账户。 |
| » remark | body | string | false | 代理账户描述 |
| » product_type | body | productTypes | false | 套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP |
Enumerated Values
| 参数 | 值 |
|---|---|
| » 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 |
删除代理账户
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/delete \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/whitelist-account/delete
请注意删除后无法恢复，已使用流量等无法查询。删除约有5分钟等待时间，在此期间仍可能产生费用。
Body parameter
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » app_key | body | string | false | 授权密钥 |
| » accounts | body | string | false | 代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户 |
响应示例
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 |
禁用代理账户
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/disable \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/whitelist-account/disable
禁用约有5分钟等待时间，在此期间仍可能产生费用。
Body parameter
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » app_key | body | string | false | 授权密钥 |
| » accounts | body | string | false | 代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户 |
响应示例
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 |
启用代理账户
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/enable \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/whitelist-account/enable
Body parameter
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » app_key | body | string | false | 授权密钥 |
| » accounts | body | string | false | 代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户 |
响应示例
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 |
修改代理账户密码
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-password \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/whitelist-account/change-password
请注意修改后有5分钟等待时间，在此期间旧密码仍可能正常使用。
Body parameter
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"password": "pass"
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » app_key | body | string | false | 授权密钥 |
| » account | body | string | false | 代理账户，仅支持数字和字母。 |
| » password | body | string | false | 代理账户新密码，仅支持数字和字母。 |
响应示例
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 |
修改代理账户备注
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-remark \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/whitelist-account/change-remark
Body parameter
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"remark": ""
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » app_key | body | string | false | 授权密钥 |
| » account | body | string | false | 代理账户，仅支持数字和字母。 |
| » remark | body | string | false | 代理账户新备注，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 |
修改代理账户流量上限
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-limit \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/whitelist-account/change-limit
请注意流量统计可能有5分钟以内延迟，即实际消耗流量可能超过此限制。
Body parameter
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"limit": 0
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » app_key | body | string | false | 授权密钥 |
| » account | body | string | false | 代理账户，仅支持数字和字母。 |
| » limit | body | integer | false | 流量限制，单位：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 |
修改代理账户信息
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/change \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/proxy-account/change
修改代理账户密码、备注、流量限制、每日流量限制、启用状态或 UDP 开关。
Body parameter
{
"app_key": "string",
"account": "string",
"password": "string",
"remark": "string",
"limit": 0,
"daily_limit": 0,
"status": 0,
"udp": 0
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » app_key | body | string | false | 授权密钥 |
| » account | body | string | false | 代理账户名 |
| » password | body | string | false | 新密码，6-16 位数字或字母；不传则不修改 |
| » remark | body | string | false | 新备注 |
| » limit | body | integer | false | 流量上限，单位 GB，0 表示不限制 |
| » daily_limit | body | integer | false | 每日流量上限，单位 GB，0 表示不限制 |
| » status | body | integer | false | 启用状态 |
| » udp | body | integer | false | UDP 支持开关，仅对套餐类型 14、16、21、25 生效 |
Enumerated Values
| 参数 | 值 |
|---|---|
| » status | 0 |
| » status | 1 |
| » udp | 0 |
| » udp | 1 |
响应示例
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 请求成功 | Inline |
响应结构
状态码 200
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | false | none | 状态码,200 成功 |
| » msg | string | false | none | 状态消息 |
| » data | null | false | none | none |
订单管理
订单创建、查询、取消等
订单列表
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/order/list \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/order/list
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| page_no | query | integer | false | none |
| page_size | query | integer | false | none |
| trade_no | query | string | false | 订单编号 |
| start_time | query | string(date-time) | false | 开始时间（包含），如 2024-01-01 00:00:00 |
| end_time | query | string(date-time) | false | 结束时间（不包含） |
| status | query | integer | false | 订单状态 |
| product_type | query | integer | false | 产品类型 |
| invoice | query | integer | false | 发票状态：0不限制 1已开发票 -1未开发票（可补开） |
| pay_fee_status | query | integer | false | 长短款筛选：1超额支付 2短款支付 |
Detailed descriptions
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|
Enumerated Values
| 参数 | 值 |
|---|---|
| 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 |
| invoice | -1 |
| invoice | 0 |
| invoice | 1 |
| pay_fee_status | 1 |
| pay_fee_status | 2 |
响应示例
200 Response
{
"code": 0,
"message": "操作成功",
"data": {
"list": [
{
"id": 0,
"trade_no": "string",
"out_trade_no": "string",
"product_id": 0,
"product_type": 0,
"amount": 0,
"unit_price": 0.1,
"total_fee": 0.1,
"goods_fee": 0.1,
"pay_fee": 0.1,
"discount_fee": 0.1,
"handling_fee": 0.1,
"refund_fee": 0.1,
"pm_id": 0,
"pm_title": "string",
"pm_logo": "string",
"status": 0,
"title": "string",
"detail": "string",
"region_desc": "string",
"pay_at": "2019-08-24T14:15:22Z",
"pay_timestamp": 0,
"created_at": "2019-08-24T14:15:22Z",
"pay_fee_status": 0,
"invoice": {
"name": "string",
"org_name": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"email": "[email protected]",
"role_type": 0,
"vat_id": "string",
"address_country": "string",
"address_city": "string",
"address_line1": "string",
"address_line2": "string",
"address_postal_code": "string"
}
}
],
"pagination": {
"total": 0,
"page_no": 0,
"page_size": 0,
"total_pages": 0
}
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
响应结构
创建订单
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/order/create \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/order/create
因套餐种类较多，且每种套餐存在不同的配置，请根据实际情况填写参数。不正当填写参数可能导致订单创建失败。
examples:
续费静态IP
{
"pid": 套餐ID, // 从 /end-point/product 接口获取
"upids": "1,2,3,4,5,6", // 从 /end-point/ip/get-static-ip 接口获取对应的 id 字段
"pm_id": 1 // 从 /end-point/payment/list 或 /end-point/payment/groups 接口获取
}
静态住宅IP购买
{
"pid": 套餐ID, // 从 /end-point/product 接口获取
"pm_id": 支付方式ID, // 从 /end-point/payment/list 或 /end-point/payment/groups 接口获取
"region_list": "JP,15,333|DE,10,444|US,5,555" // 格式：地区,数量,ASN|地区,数量,ASN（ASN编号可选）
}
静态数据中心IP购买
{
"pid": 套餐ID, // 从 /end-point/product 接口获取
"pm_id": 支付方式ID, // 从 /end-point/payment/list 或 /end-point/payment/groups 接口获取
"region_list": "JP,15,333|DE,10,444|US,5,555" // 格式：地区,数量,ASN|地区,数量,ASN（ASN编号可选）
}
动态住宅流量购买
{
"pid": 套餐ID, // 从 /end-point/product 接口获取
"pm_id": 支付方式ID // 从 /end-point/payment/list 或 /end-point/payment/groups 接口获取
}
静态轮换流量购买
{
"pid": 套餐ID, // 从 /end-point/product 接口获取
"pm_id": 支付方式ID // 从 /end-point/payment/list 或 /end-point/payment/groups 接口获取
}
动态无限流量购买
{
"pid": 套餐ID, // 从 /end-point/product 接口获取
"pm_id": 支付方式ID, // 从 /end-point/payment/list 或 /end-point/payment/groups 接口获取
"product_sku_bandwidth_id": 带宽规格ID,
"product_sku_concurrency_id": 并发规格ID
}
余额充值
{
"pid": 套餐ID, // 从 /end-point/product 接口获取
"pm_id": 支付方式ID, // 从 /end-point/payment/list 或 /end-point/payment/groups 接口获取
"recharge_amount": 充值金额
}
Body parameter
{
"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,
"product_sku_duration_id": 0,
"etd": 1,
"recharge_amount": 0
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 | | --- | --- | --- | --- | --- | --- | --- | --- | | body | body | object | true | none | | » pid | body | integer | true | 套餐ID，来自 /end-point/product 接口返回的 id 字段 | | » upids | body | string | false | 续费套餐ID列表（逗号分隔），来自 /end-point/user-product/list 或 /end-point/ip/get-static-ip 接口返回的 id 字段 | | » amount | body | number | false | 新购套餐数量 | | » pm_id | body | integer | true | 支付方式ID，来自 /end-point/payment/list 或 /end-point/payment/groups 接口返回的 id 字段 | | » region_list | body | string | false | 购买静态IP时指定区域+数量+ASN编号，格式：地区,数量,ASN | 地区,数量,ASN，例如：JP,15,333 | DE,10,444 | US,5,555（ASN编号可选） | | » coupon_sn | body | string | false | 优惠券编号 | | » use_invitation_registration_discount | body | boolean | false | 是否使用邀请注册优惠 | | » renew_duration | body | integer | false | 续费时长-静态IP可选 | | » product_sku_bandwidth_id | body | integer | false | 套餐11：带宽套餐ID | | » product_sku_concurrency_id | body | integer | false | 套餐11：并发套餐ID | | » product_sku_duration_id | body | integer | false | 套餐type=11必填：时长规格ID | | » etd | body | integer | false | 时长倍数，从套餐 extension_of_time_days 获取，2代表天数×2，价格上浮 | | » recharge_amount | body | integer | false | 套餐3：充值金额 |
响应示例
200 Response
{
"code": 0,
"message": "操作成功",
"data": {
"id": 0,
"trade_no": "string",
"out_trade_no": "string",
"product_id": 0,
"product_type": 0,
"amount": 0,
"unit_price": 0.1,
"total_fee": 0.1,
"goods_fee": 0.1,
"pay_fee": 0.1,
"discount_fee": 0.1,
"handling_fee": 0.1,
"refund_fee": 0.1,
"pm_id": 0,
"pm_title": "string",
"pm_logo": "string",
"status": 0,
"title": "string",
"detail": "string",
"region_desc": "string",
"pay_at": "2019-08-24T14:15:22Z",
"pay_timestamp": 0,
"created_at": "2019-08-24T14:15:22Z",
"pay_fee_status": 0,
"invoice": {
"name": "string",
"org_name": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"email": "[email protected]",
"role_type": 0,
"vat_id": "string",
"address_country": "string",
"address_city": "string",
"address_line1": "string",
"address_line2": "string",
"address_postal_code": "string"
}
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 创建成功 | Inline |
响应结构
取消订单
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/order/close \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/order/close
Body parameter
{
"trade_no": "string"
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | true | none |
| » trade_no | body | string | true | none |
响应示例
200 Response
{
"code": 0,
"message": "操作成功",
"data": {}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 操作成功 | SuccessResponse |
订单预检
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/order/check \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/order/check
创建订单前调用，用于预览价格、折扣、IP续费明细等，不会实际创建订单。参数与 /end-point/order/create 完全一致。
Body parameter
{
"pid": 0,
"upids": "string",
"amount": 1,
"pm_id": 0,
"region_list": "string",
"coupon_sn": "string",
"renew_duration": "1m",
"product_sku_bandwidth_id": 0,
"product_sku_concurrency_id": 0,
"product_sku_duration_id": 0,
"etd": 1,
"recharge_amount": 0
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 | | ---------------------------- | ---- | ------- | ----- | --------------------------------------------- | ----------- | | body | body | object | true | none | | » pid | body | integer | true | 套餐ID | | » upids | body | string | false | IP续费：用户套餐ID列表，逗号分隔 | | » amount | body | integer | false | 购买数量 | | » pm_id | body | integer | true | 支付方式ID | | » region_list | body | string | false | 静态IP购买地区+数量，格式：地区ID,数量 | 地区ID,数量 | | » coupon_sn | body | string | false | 优惠券编号 | | » renew_duration | body | string | false | IP续费时长：1m=1个月，2m=2个月，em=下个月月底 | | » product_sku_bandwidth_id | body | integer | false | 套餐type=11必填：带宽规格ID | | » product_sku_concurrency_id | body | integer | false | 套餐type=11必填：并发规格ID | | » product_sku_duration_id | body | integer | false | 套餐type=11必填：时长规格ID | | » etd | body | integer | false | 时长倍数，从套餐 extension_of_time_days 获取 | | » recharge_amount | body | number | false | 套餐type=3必填：充值金额 |
Enumerated Values
| 参数 | 值 |
|---|---|
| » renew_duration | 1m |
| » renew_duration | 2m |
| » renew_duration | em |
响应示例
200 Response
{
"code": 0,
"message": "操作成功",
"data": {
"product_id": 0,
"amount": 0,
"discount_fee": 0.1,
"total_fee": 0.1,
"pay_fee": 0.1,
"product_type": 0,
"title": "string",
"detail": "string",
"ip_result": [
{
"ip": "string",
"price": 0.1,
"country_code": "string",
"current_time": "2019-08-24T14:15:22Z",
"renewal_time": "2019-08-24T14:15:22Z",
"country": {
"name_zh_cn": "string",
"flag": "string",
"square_flag": "string"
}
}
]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 预检成功 | Inline |
响应结构
IP白名单
IP 白名单列表
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/proxy-ip/list?app_key=pa%24%24word \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/proxy-ip/list
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| app_key | query | string(password) | true | 认证密钥 |
| product_type | query | integer | false | 套餐类型编号 |
响应示例
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"ip": "1.1.1.1",
"remark": "string",
"product_type": 0,
"created_at": "string"
}
]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 请求成功 | Inline |
响应结构
状态码 200
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | false | none | 状态码,200 成功 |
| » msg | string | false | none | 状态消息 |
| » data | object | false | none | none |
| »» list | [object] | false | none | none |
| »»» ip | string | false | none | 白名单 IP |
| »»» remark | string | false | none | 备注 |
| »»» product_type | integer | false | none | 套餐类型 |
| »»» created_at | string | false | none | 创建时间 |
添加 IP 白名单
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/add \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/proxy-ip/add
Body parameter
{
"app_key": "string",
"ips": "1.1.1.1,2.2.2.2",
"remark": "string",
"product_type": 0,
"user_product_id": 0
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » app_key | body | string | false | 授权密钥 |
| » ips | body | string | false | 需要添加的白名单 IP，多个用英文逗号或换行分隔 |
| » remark | body | string | false | 备注 |
| » product_type | body | integer | false | 套餐类型编号 |
| » user_product_id | body | integer | false | 用户套餐 ID，套餐类型为 11 时必填 |
响应示例
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 请求成功 | Inline |
响应结构
状态码 200
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | false | none | 状态码,200 成功 |
| » msg | string | false | none | 状态消息 |
| » data | null | false | none | none |
删除 IP 白名单
Code samples
# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/delete \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST /end-point/proxy-ip/delete
Body parameter
{
"app_key": "string",
"ips": "1.1.1.1,2.2.2.2",
"verify_type": "string",
"verify_code": "string"
}
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » app_key | body | string | false | 授权密钥 |
| » ips | body | string | false | 需要删除的白名单 IP，多个用英文逗号分隔 |
| » verify_type | body | string | false | 验证类型：phone、email、wechat、totp |
| » verify_code | body | string | false | 验证码 |
响应示例
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 请求成功 | Inline |
响应结构
状态码 200
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | false | none | 状态码,200 成功 |
| » msg | string | false | none | 状态消息 |
| » data | null | false | none | none |
流量日志查询
使用流量按天汇总
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/total?app_key=pa%24%24word \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/user-usage-flow/total
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| app_key | query | string(password) | true | 认证密钥 |
| start_time | query | string(Y-m-d H:i:s) | false | 起始时间，可精确到秒。请注意，日志记录有5分钟以内延迟。默认7天以内。 |
| end_time | query | string(Y-m-d H:i:s) | false | 截止时间，可精确到秒。请注意，日志记录有5分钟以内延迟。默认当前时间。 |
| username | query | string | false | 子账户名称,默认查询所有账户，可指定子账户。请注意如果您添加了相同名称的子账户，此查询将返回同名代理账户的所有使用记录。 |
| product_type | query | number | false | 套餐类型 |
响应示例
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 |
套餐查询
已购套餐列表
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-product/list?app_key=pa%24%24word \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/user-product/list
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| app_key | query | string(password) | true | 认证密钥 |
| trade_no | query | string | false | 订单号，请输入完整订单号。不支持模糊搜索。 |
| page | query | number | false | 分页，默认：1 |
| size | query | number | false | 分页显示数量,默认：20 |
| product_type | query | number | false | 套餐类型 |
响应示例
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 | 总分页数量 |
Enumerated Values
| 属性 | 值 |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
用户套餐数据汇总
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-product/summary?app_key=pa%24%24word \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/user-product/summary
获取用户套餐的统计汇总信息，包括总量、有效量、临期量、过期量等
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| app_key | query | string(password) | true | 认证密钥 |
| product_type | query | integer | false | 产品类型，仅支持 9（动态流量套餐）、12（长效IDC流量套餐） |
Enumerated Values
| 参数 | 值 |
|---|---|
| product_type | 9 |
| product_type | 12 |
响应示例
200 Response
{
"code": 200,
"msg": "成功",
"data": {
"total": 1048576,
"total_count": 5,
"effective": 524288,
"effective_count": 3,
"effective_total": 786432,
"effective_used": 262144,
"temporary": 102400,
"temporary_count": 1,
"expired": 51200,
"expired_count": 1,
"used": 473088
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 请求成功 | Inline |
响应结构
状态码 200
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | false | none | 状态码,200 成功、3 app_key 无效、156 账户未实名认证 |
| » msg | string | false | none | 状态消息 |
| » data | object | false | none | none |
| »» total | integer | false | none | 流量/IP总量（单位：KB） |
| »» total_count | integer | false | none | 套餐总个数 |
| »» effective | integer | false | none | 有效剩余量（单位：KB） |
| »» effective_count | integer | false | none | 有效套餐个数 |
| »» effective_total | integer | false | none | 有效总量（单位：KB） |
| »» effective_used | integer | false | none | 有效已使用量（单位：KB） |
| »» temporary | integer | false | none | 临期总量（7天内到期，单位：KB） |
| »» temporary_count | integer | false | none | 临期套餐个数（7天内到期） |
| »» expired | integer | false | none | 过期剩余量（单位：KB） |
| »» expired_count | integer | false | none | 过期套餐个数 |
| »» used | integer | false | none | 已使用总量（单位：KB） |
IP提取
提取IP
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/v3?app_key=pa%24%24word \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/ip/v3
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| app_key | query | string(password) | true | 访问密钥 |
| cc | query | string | false | 国家或地区 |
| state | query | string | false | 省或州 |
| city | query | string | false | 城市 |
| format | query | string | false | 获取格式 |
| lb | query | string | false | 间隔符，仅text格式有效 |
| num | query | number | false | 提取数量 |
| life | query | number | false | 保持周期-分钟 |
| ep | query | string | false | 代理网络 |
Enumerated Values
| 参数 | 值 |
|---|---|
| ep | us |
| ep | hk |
| ep | de |
响应示例
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 |
动态地区城市列表V4
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dcl4?username=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/ip/dcl4
按用户名获取城市列表，需要登录认证，且账户必须属于当前用户
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| username | query | string | true | 代理账户用户名 |
响应示例
200 Response
{
"code": 200,
"msg": "string",
"data": {
"cache": true,
"list": [
{
"City": "Los Angeles",
"Area": "US",
"State": "California"
}
]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 请求成功 | Inline |
响应结构
状态码 200
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | false | none | 状态码,200 成功 |
| » msg | string | false | none | 状态消息 |
| » data | object | false | none | none |
| »» cache | boolean | false | none | 是否来自缓存 |
| »» list | [object] | false | none | none |
| »»» City | string | false | none | 城市 |
| »»» Area | string | false | none | 地区 |
| »»» State | string | false | none | 州/省 |
动态地区州/省列表V4
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dsl4?username=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/ip/dsl4
按用户名获取州/省列表，需要登录认证，且账户必须属于当前用户
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| username | query | string | true | 代理账户用户名 |
响应示例
200 Response
{
"code": 200,
"msg": "string",
"data": {
"cache": true,
"list": [
{
"City": "Los Angeles",
"Area": "US",
"State": "California"
}
]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 请求成功 | Inline |
响应结构
状态码 200
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | false | none | 状态码,200 成功 |
| » msg | string | false | none | 状态消息 |
| » data | object | false | none | none |
| »» cache | boolean | false | none | 是否来自缓存 |
| »» list | [object] | false | none | none |
| »»» City | string | false | none | 城市 |
| »»» Area | string | false | none | 地区 |
| »»» State | string | false | none | 州/省 |
动态地区州/省城市融合列表V4
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dal4?username=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/ip/dal4
按用户名获取州/省和城市的融合列表，按地区分组。需要登录认证，且账户必须属于当前用户
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| username | query | string | true | 代理账户用户名 |
响应示例
200 Response
{
"code": 200,
"msg": "string",
"data": {
"cache": true,
"list": [
{
"Area": "US",
"states": [
{
"State": "California",
"cities": ["Los Angeles"]
}
]
}
]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 请求成功 | Inline |
响应结构
状态码 200
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | false | none | 状态码,200 成功 |
| » msg | string | false | none | 状态消息 |
| » data | object | false | none | none |
| »» cache | boolean | false | none | 是否来自缓存 |
| »» list | [object] | false | none | 地区列表 |
| »»» Area | string | false | none | 地区代码 |
| »»» states | [object] | false | none | 州/省列表 |
| »»»» State | string | false | none | 州/省名称 |
| »»»» cities | [string] | false | none | 城市列表 |
城市列表
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
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": "Arlington",
"state": "alabama",
"continent_code": "NA",
"country_code": "US"
}
]
}
]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 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 | [any] | false | none | 省或州 |
| »»»» city | string | false | none | 城市名称 |
| »»»» state | string | false | none | 省或州名称代码 |
| »»»» continent_code | string | false | none | 大洲代码 |
| »»»» country_code | string | false | none | 国家或地区代码 |
城市搜索
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys/search?country_code=string&state=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/ip/dynamic-citys/search
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| country_code | query | string | true | 国家或地区代码 |
| state | query | string | true | 州或省代码 |
响应示例
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 | 列表 |
州列表
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
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": "alabama",
"continent_code": "NA",
"country_code": "US"
}
]
}
]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 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 | [any] | false | none | 省或州 |
| »»»» state | string | false | none | 省或州名称代码 |
| »»»» continent_code | string | false | none | 大洲代码 |
| »»»» country_code | string | false | none | 国家或地区代码 |
州/省搜索
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states/search?country_code=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/ip/dynamic-states/search
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| country_code | query | string | true | 国家或地区代码 |
响应示例
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 | 列表 |
提取已购买静态IP列表
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/get-static-ip \
-H 'Authorization: Bearer {access-token}'
GET /end-point/ip/get-static-ip
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| country_code | query | string | false | 国家或地区代码 |
| product_type | query | number | false | 产品类型, 25:静态住宅IP, 14: 数据中心IP |
| trade_no | query | string | false | 通过订单号筛选IP |
| page | query | number | false | 页码 |
| size | query | number | false | 每页数量 |
| status | query | number | false | 状态, 1:有效, 2:无效, 3:即将过期, 4:维护中 |
Enumerated Values
| 参数 | 值 |
|---|---|
| product_type | 14 |
| product_type | 25 |
| status | 1 - 2 - 3 - 4 |
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|
获取在售地区静态IP数量
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/static-ip-region \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/ip/static-ip-region
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| isp | query | integer | false | ISP 筛选，不传则不筛选（站点 1/4/5 除外默认为 1） |
| asn | query | integer | false | 是否返回 ASN 分组数据 |
| exclusive | query | integer | false | 是否按独享库存统计 |
Detailed descriptions
isp: ISP 筛选，不传则不筛选（站点 1/4/5 除外默认为 1）
| 值 | 描述 |
|---|---|
| 0 | 数据中心静态IP（IDC） |
| 1 | 家庭住宅静态IP（ISP） |
asn: 是否返回 ASN 分组数据
| 值 | 描述 |
|---|---|
| 0 | 不返回 ASN 分组数据（默认） |
| 1 | 返回 ASN 分组数据 |
exclusive: 是否按独享库存统计
| 值 | 描述 |
|---|---|
| 0 | 按当前用户/共享组口径统计（默认） |
| 1 | 排除所有已分配IP，仅统计可用库存 |
Enumerated Values
| 参数 | 值 |
|---|---|
| isp | 0 |
| isp | 1 |
| asn | 0 |
| asn | 1 |
| exclusive | 0 |
| exclusive | 1 |
响应示例
200 Response
{
"code": 200,
"msg": "请求成功",
"data": {
"list": [
{
"code": "US",
"number": 55
}
]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 请求成功 | Inline |
响应结构
状态码 200
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | false | none | 状态码,200 成功 |
| » msg | string | false | none | 状态消息 |
| » data | object | false | none | none |
| »» list | [any] | false | none | none |
| »»» code | string | false | none | 国家或地区代码 |
| »»» number | integer | false | none | 数量 |
获取 host_pool 支持国家/地区
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/host-pool/regions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/host-pool/regions
查询 host_pool 服务当前站点支持的国家/地区列表。
该接口面向数据中心 IP 按流量积分的随机提取场景，仅按当前站点可用数据中心 IP 库存统计国家/地区。不支持 ASN、ISP、独享库存筛选，也不会按用户已购买记录排除 IP。
响应示例
200 Response
{
"code": 200,
"msg": "请求成功",
"data": {
"list": [
{
"code": "US",
"number": 55,
"name_zh_cn": "美国",
"name_en": "United States",
"square_flag": "https://example.com/static/flags/us.png"
}
]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 请求成功 | 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 | 国家或地区代码，ISO 3166-1 alpha-2 |
| »»» number | integer | false | none | 当前站点可用数据中心 IP 数量 |
| »»» name_zh_cn | string | false | none | 国家或地区中文名称 |
| »»» name_en | string | false | none | 国家或地区英文名称 |
| »»» square_flag | string | false | none | 方形国旗图片 URL |
支付管理
获取支付方式列表
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/payment/groups \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/payment/groups
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| trade_no | query | undefined | false | 订单号 - 部分订单需要获取特定支付方式时可传入 |
响应示例
200 Response
{
"code": 0,
"message": "操作成功",
"data": {
"list": [
{
"name": "string",
"logos": ["string"],
"items": [
{
"id": 0,
"title": "string",
"logo": "string",
"group": "string",
"disabled": false,
"min": 0,
"max": 0
}
]
}
]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 获取成功 | Inline |
响应结构
营销
充值赠金比例
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/activity/balance-recharge-gift-ratio \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/activity/balance-recharge-gift-ratio
充值赠金比例
响应示例
200 Response
{
"code": 0,
"message": "操作成功",
"data": {
"list": [null]
}
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | OK | Inline |
响应结构
产品
产品列表
Code samples
# You can also use wget
curl -X GET https://api.proxylite.com/end-point/product \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET /end-point/product
获取当前站点可购买的套餐列表，支持按类型、有效期等条件筛选。
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| type | query | integer | false | 套餐类型，见 Product.type 枚举说明。不传则返回所有类型。 |
| parent_product_type | query | integer | false | 父套餐类型，仅 type=19（IP续费）时有效，用于筛选产品线：14=数据中心 25=住宅 |
| time_days | query | any | false | 有效期天数筛选，支持单值或数组，如 30 / [30,90,365] |
| show_type | query | any | false | 展示类型筛选，支持单值或数组 |
Detailed descriptions
type: 套餐类型，见 Product.type 枚举说明。不传则返回所有类型。
Enumerated Values
| 参数 | 值 |
|---|---|
| parent_product_type | 14 |
| parent_product_type | 25 |
响应示例
200 Response
{
"code": 0,
"message": "操作成功",
"data": [
{
"id": 0,
"title": "string",
"type": 0,
"show_type": 0,
"status": 0,
"price": 0.1,
"usd_price": 0.1,
"price_hkd": 0.1,
"original_price": 0.1,
"original_usd_price": 0.1,
"original_price_hkd": 0.1,
"local_price": 0.1,
"local_original_price": 0.1,
"preferred_currency": "string",
"support_currencies": "string",
"flow_value": 0.1,
"flow_give": 0.1,
"balance_give": 0.1,
"balance_value": 0.1,
"time_validity": 0.1,
"time_price": 0.1,
"time_days": 0,
"tip1": "string",
"tip2": "string",
"introduce": ["string"],
"region_list_id": 0,
"renew_product_list": "string",
"parent_product_type": 0,
"total_count": 0,
"remain_count": 0,
"extension_of_time_days": [0],
"time_days_price_rate": 0.1,
"desc": {
"subtitle": "string",
"flow_value": 0.1,
"flow_give": 0.1,
"balance_give": 0.1,
"time_validity": 0.1,
"time_price": 0.1,
"tip1": "string",
"tip2": "string",
"introduce": ["string"]
},
"sku": {
"bandwidth_list": [
{
"id": 0,
"value": 0,
"price": 0.1,
"price_usd": 0.1,
"price_hkd": 0.1
}
],
"duration_list": [
{
"id": 0,
"value": 0,
"price": 0.1,
"price_usd": 0.1,
"price_hkd": 0.1
}
],
"concurrency_list": [
{
"id": 0,
"value": 0,
"price": 0.1,
"price_usd": 0.1,
"price_hkd": 0.1
}
]
}
}
]
}
响应
| 状态码 | 含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | OK | Inline |
响应结构
Schemas
productTypes
9
套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| anonymous | integer | false | none | 套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP |
Enumerated Values
| 属性 | 值 |
|---|---|
| anonymous | 9 |
| anonymous | 11 |
| anonymous | 14 |
| anonymous | 25 |
apiKey
{}
认证密钥
Properties
None
responseCode
200
状态码,200 成功、3 app_key 无效
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| anonymous | integer | false | none | 状态码,200 成功、3 app_key 无效 |
responseMsg
"success"
response message
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| anonymous | string | false | none | response message |
SuccessResponse
{
"code": 0,
"message": "操作成功",
"data": {}
}
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| code | integer | false | none | none |
| message | string | false | none | none |
| data | object | false | none | none |
ErrorResponse
{
"code": 400,
"message": "参数错误",
"errors": {}
}
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| code | integer | false | none | none |
| message | string | false | none | none |
| errors | object | false | none | none |
User
{
"id": 0,
"email": "[email protected]",
"phone": "string",
"balance": 0.1,
"status": 0,
"is_real_name": true,
"created_at": "2019-08-24T14:15:22Z"
}
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| id | integer | false | none | none |
| 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",
"out_trade_no": "string",
"product_id": 0,
"product_type": 0,
"amount": 0,
"unit_price": 0.1,
"total_fee": 0.1,
"goods_fee": 0.1,
"pay_fee": 0.1,
"discount_fee": 0.1,
"handling_fee": 0.1,
"refund_fee": 0.1,
"pm_id": 0,
"pm_title": "string",
"pm_logo": "string",
"status": 0,
"title": "string",
"detail": "string",
"region_desc": "string",
"pay_at": "2019-08-24T14:15:22Z",
"pay_timestamp": 0,
"created_at": "2019-08-24T14:15:22Z",
"pay_fee_status": 0,
"invoice": {
"name": "string",
"org_name": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"email": "[email protected]",
"role_type": 0,
"vat_id": "string",
"address_country": "string",
"address_city": "string",
"address_line1": "string",
"address_line2": "string",
"address_postal_code": "string"
}
}
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 | | --------------------- | ----------------- | ----- | ---- | ------------------------------------------ | --- | ---- | ---- | --- | --- | ---- | --- | ------ | ---- | --- | ------ | ---- | --- | -------- | ---- | --- | ------ | --- | | id | integer | false | none | 订单ID | | trade_no | string | false | none | 内部订单编号 | | out_trade_no | string | false | none | 外部订单编号 | | product_id | integer | false | none | 套餐ID | | product_type | integer | false | none | 套餐类型，见产品类型枚举 | | amount | integer | false | none | 购买数量 | | unit_price | number(float) | false | none | 单价 | | total_fee | number(float) | false | none | 订单总价（不含折扣，含手续费） | | goods_fee | number(float) | false | none | 商品价格（含折扣，不含手续费） | | pay_fee | number(float) | false | none | 实付金额（含折扣，含手续费） | | discount_fee | number(float) | false | none | 优惠金额 | | handling_fee | number(float) | false | none | 手续费 | | refund_fee | number(float) | false | none | 退款金额 | | pm_id | integer | false | none | 支付方式ID（来自 /end-point/payment/list） | | pm_title | string | false | none | 支付方式名称 | | pm_logo | string | false | none | 支付方式Logo URL | | status | integer | false | none | 订单状态
| 值 | 描述 |
| --- | --- |
| 0 | 待支付 |
| 1 | 已支付 |
| 2 | 超时取消 |
| 3 | 已退款 | | | title | string | false | none | 套餐标题 | | detail | string | false | none | 套餐描述 | | region_desc | string | false | none | 地区规格描述 | | pay_at | string(date-time) | false | none | 支付时间 | | pay_timestamp | integer | false | none | 支付时间戳 | | created_at | string(date-time) | false | none | 创建时间 | | pay_fee_status | integer | false | none | 长短款状态：0正常 1长款（超额支付） 2短款 | | invoice | object | false | none | 发票信息（仅线上支付订单有值） | | » name | string | false | none | 全名 | | » org_name | string | false | none | 企业名称 | | » first_name | string | false | none | none | | » last_name | string | false | none | none | | » phone | string | false | none | none | | » email | string(email) | false | none | none | | » role_type | integer | false | none | 1个人 2企业 | | » vat_id | string | false | none | 税号 | | » address_country | string | false | none | none | | » address_city | string | false | none | none | | » address_line1 | string | false | none | none | | » address_line2 | string | false | none | none | | » address_postal_code | string | false | none | none |
OrderCheckResult
{
"product_id": 0,
"amount": 0,
"discount_fee": 0.1,
"total_fee": 0.1,
"pay_fee": 0.1,
"product_type": 0,
"title": "string",
"detail": "string",
"ip_result": [
{
"ip": "string",
"price": 0.1,
"country_code": "string",
"current_time": "2019-08-24T14:15:22Z",
"renewal_time": "2019-08-24T14:15:22Z",
"country": {
"name_zh_cn": "string",
"flag": "string",
"square_flag": "string"
}
}
]
}
订单预检结果
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| product_id | integer | false | none | 套餐ID |
| amount | integer | false | none | 数量 |
| discount_fee | number(float) | false | none | 优惠金额 |
| total_fee | number(float) | false | none | 订单总额 |
| pay_fee | number(float) | false | none | 实付金额 |
| product_type | integer | false | none | 套餐类型 |
| title | string | false | none | 套餐标题 |
| detail | string | false | none | 套餐描述 |
| ip_result | [object] | false | none | IP批量续费结果（仅IP续费时返回） |
| » ip | string | false | none | none |
| » price | number(float) | false | none | none |
| » country_code | string | false | none | none |
| » current_time | string(date-time) | false | none | none |
| » renewal_time | string(date-time) | false | none | none |
| » country | object | false | none | none |
| »» name_zh_cn | string | false | none | none |
| »» flag | string | false | none | 圆形旗帜URL |
| »» square_flag | string | false | none | 方形旗帜URL |
Product
{
"id": 0,
"title": "string",
"type": 0,
"show_type": 0,
"status": 0,
"price": 0.1,
"usd_price": 0.1,
"price_hkd": 0.1,
"original_price": 0.1,
"original_usd_price": 0.1,
"original_price_hkd": 0.1,
"local_price": 0.1,
"local_original_price": 0.1,
"preferred_currency": "string",
"support_currencies": "string",
"flow_value": 0.1,
"flow_give": 0.1,
"balance_give": 0.1,
"balance_value": 0.1,
"time_validity": 0.1,
"time_price": 0.1,
"time_days": 0,
"tip1": "string",
"tip2": "string",
"introduce": ["string"],
"region_list_id": 0,
"renew_product_list": "string",
"parent_product_type": 0,
"total_count": 0,
"remain_count": 0,
"extension_of_time_days": [0],
"time_days_price_rate": 0.1,
"desc": {
"subtitle": "string",
"flow_value": 0.1,
"flow_give": 0.1,
"balance_give": 0.1,
"time_validity": 0.1,
"time_price": 0.1,
"tip1": "string",
"tip2": "string",
"introduce": ["string"]
},
"sku": {
"bandwidth_list": [
{
"id": 0,
"value": 0,
"price": 0.1,
"price_usd": 0.1,
"price_hkd": 0.1
}
],
"duration_list": [
{
"id": 0,
"value": 0,
"price": 0.1,
"price_usd": 0.1,
"price_hkd": 0.1
}
],
"concurrency_list": [
{
"id": 0,
"value": 0,
"price": 0.1,
"price_usd": 0.1,
"price_hkd": 0.1
}
]
}
}
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 | | ---------------------- | ------------- | ----- | ---- | --------------------------------------------------- | --- | ---- | ---- | --- | --- | ---- | --- | -------- | ---- | --- | ---------------- | ---- | --- | ---------------- | ---- | --- | ------------------------------- | ---- | --- | --------------- | ---- | --- | ------------------ | ---- | --- | ------------------ | ---- | --- | --------------- | ---- | --- | ------------ | ---- | --- | -------------- | ---- | --- | -------------- | ---- | --- | -------------- | ---- | --- | -------------- | ---- | --- | ------------------ | ---- | --- | -------------- | --- | | id | integer | false | none | 套餐ID | | title | string | false | none | 套餐主标题 | | type | integer | false | none | 套餐类型
| 值 | 描述 |
| --- | --- |
| 3 | 余额充值 |
| 9 | 动态住宅流量套餐 |
| 10 | 动态全球包时套餐 |
| 11 | 定制动态全球包时套餐V2（含SKU） |
| 12 | 长效IDC流量套餐 |
| 13 | 住宅静态IP流量套餐 |
| 14 | 数据中心静态IP套餐 |
| 15 | 长效ISP流量套餐 |
| 16 | 静态流量套餐 |
| 17 | 动态住宅IP套餐 |
| 19 | 静态IP续费套餐 |
| 20 | 静态IP更换资格 |
| 21 | 静态住宅IP套餐 |
| 24 | 静态流量附加包套餐 |
| 25 | 静态IP速率套餐 | | | show_type | integer | false | none | 展示类型：1普通 2大额推荐 3不可购买（需定制） 4试用 | | status | integer | false | none | 状态：1上架 0下架 | | price | number(float) | false | none | 人民币价格 | | usd_price | number(float) | false | none | 美元价格 | | price_hkd | number(float) | false | none | 港币价格 | | original_price | number(float) | false | none | 原价（CNY） | | original_usd_price | number(float) | false | none | 原价（USD） | | original_price_hkd | number(float) | false | none | 原价（HKD） | | local_price | number(float) | false | none | 本地化价格（依赖 preferred_currency） | | local_original_price | number(float) | false | none | 本地化原价（依赖 preferred_currency） | | preferred_currency | string | false | none | 推荐显示货币，如 usd / cny / hkd | | support_currencies | string | false | none | 支持的货币列表，逗号分隔，如 usd,cny | | flow_value | number(float) | false | none | 流量套餐默认流量（GB） | | flow_give | number(float) | false | none | 赠送流量（GB） | | balance_give | number(float) | false | none | 余额充值赠送金额 | | balance_value | number(float) | false | none | 充值金额 | | time_validity | number(float) | false | none | 包量套餐默认有效时长 | | time_price | number(float) | false | none | 包量套餐每IP价格 | | time_days | integer | false | none | 有效期天数，如 30/90/180/365 | | tip1 | string | false | none | 标签说明1 | | tip2 | string | false | none | 标签说明2 | | introduce | [string] | false | none | 文本介绍列表 | | region_list_id | integer | false | none | 地区ID | | renew_product_list | string | false | none | 可续订套餐ID列表（逗号分隔） | | parent_product_type | integer | false | none | 父套餐类型（type=19时有效）：14或25 | | total_count | integer | false | none | 总库存，0表示不限制 | | remain_count | integer | false | none | 剩余库存 | | extension_of_time_days | [integer] | false | none | 时长倍数列表，为空或仅含1表示不支持 | | time_days_price_rate | number(float) | false | none | 时长价格系数，价格 × (1 + (倍数-1) × rate) | | desc | object | false | none | 套餐描述信息 | | » subtitle | string | false | none | 副标题 | | » flow_value | number(float) | false | none | none | | » flow_give | number(float) | false | none | none | | » balance_give | number(float) | false | none | none | | » time_validity | number(float) | false | none | none | | » time_price | number(float) | false | none | none | | » tip1 | string | false | none | none | | » tip2 | string | false | none | none | | » introduce | [string] | false | none | none | | sku | object | false | none | 规格参数（type=11时返回） | | » bandwidth_list | [object] | false | none | 带宽规格列表 | | »» id | integer | false | none | none | | »» value | integer | false | none | 带宽值（Mbps） | | »» price | number(float) | false | none | none | | »» price_usd | number(float) | false | none | none | | »» price_hkd | number(float) | false | none | none | | » duration_list | [object] | false | none | 时长规格列表 | | »» id | integer | false | none | none | | »» value | integer | false | none | 时长（天） | | »» price | number(float) | false | none | none | | »» price_usd | number(float) | false | none | none | | »» price_hkd | number(float) | false | none | none | | » concurrency_list | [object] | false | none | 并发规格列表 | | »» id | integer | false | none | none | | »» value | integer | false | none | 并发数 | | »» price | number(float) | false | none | none | | »» price_usd | number(float) | false | none | none | | »» price_hkd | number(float) | false | none | none |
WhiteIp
{
"id": 0,
"ip": "string",
"remark": "string",
"created_at": "2019-08-24T14:15:22Z"
}
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| 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
}
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| 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"
}
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| 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"
}
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| 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
}
Properties
| 名称 | 类型 | 必填 | 约束 | 说明 |
|---|---|---|---|---|
| total | integer | false | none | none |
| page_no | integer | false | none | none |
| page_size | integer | false | none | none |
| total_pages | integer | false | none | none |