浏览端点
ProxyWing 开发者 API
API 参考
借助 ProxyWing API,您可以通过编程方式管理账户并开通代理。所有请求均通过 HTTPS 发送到同一个基础 URL,并使用 Bearer API 密钥进行身份验证。
https://api.proxywing.com/v1在控制面板的账户 → 安全中获取您的 API 密钥。
身份验证
在控制面板的账户 → 安全中获取 API 密钥。每个请求都必须在 Authorization 请求头中以 Bearer 令牌的形式携带该密钥:
Authorization: Bearer pk_live_XXXXXXXX正式密钥以 pk_live_ 为前缀。可随时通过 GET /account/api-keys 和 DELETE /account/api-keys/{key_pub_id} 为密钥设置权限范围或撤销密钥。
错误
每个错误响应体都是 JSON,带有顶层 detail 键。其中的内容有三种形式,因此请先读取 HTTP 状态码,再将 detail 视为字符串、对象或数组。
// 1. A plain message — most 400 / 401 / 403 / 404 responses
{ "detail": "Order not found" }
// 2. A coded error — newer endpoints (sub-users, gateways, whitelist removal).
// Branch on detail.error.code; the message is for humans and may change.
{
"detail": {
"error": {
"code": "insufficient_unallocated_traffic",
"message": "not enough unallocated traffic on this service"
}
}
}
// 3. Request validation — always HTTP 422, one entry per rejected field
{
"detail": [
{
"type": "value_error",
"loc": ["body", "gb"],
"msg": "Value error, gb must be a whole number of GB (1, 2, 3, ...); got 1.5",
"input": 1.5
}
]
}健壮的客户端会先读取状态码,再检查 detail 是否为包含 error.code 的对象,之后才回退为将其作为文本渲染。本参考中提到的错误码始终位于 detail.error.code。
| 状态 | 含义 |
|---|---|
| 400 | 请求错误——参数格式错误或缺失。 |
| 401 | 未授权——API 密钥缺失或无效。 |
| 404 | 未找到——此账户中不存在该资源。 |
| 409 | 冲突——请求与资源的当前状态冲突。 |
| 429 | 请求过多——超出速率限制。 |
| 500 | 服务器内部错误——请使用退避策略重试。 |
速率限制
请求限制为每个 IP 每分钟 600 次请求。超出限制将返回 429 状态码——请退避并在短暂延迟后重试。
幂等性
下单、续期、充值和子用户写入端点必须携带 Idempotency-Key 请求头——省略它会在任何扣费或创建发生之前返回 400。请为每个新请求发送一个唯一键(使用 UUID 即可);在超时或网络错误后使用同一个键重试,可保证该操作最多只执行一次。
重放的请求会返回原始结果,并带有 Idempotent-Replayed: true 响应头,因此您可以区分可安全忽略的重试与全新的写入——无论哪种情况,响应体本身都完全相同。
有两个例外值得在代码中处理。子用户的 allocate 和 reclaim 不会重放:重复使用的键会返回 409 request_in_progress,而不是先前的结果,因此请为每次尝试使用新键,并重新读取子用户以确认状态。此外,如果重复使用的键所对应的子用户此后已被删除,将返回 409 idempotency_key_reused,而不是已失效的记录。
账户
资料、钱包余额、账单、服务、自动续费和 API 密钥管理。
8 个端点产品与订单
浏览固定价格的数据中心和 ISP 目录,并使用余额下单。
2 个端点数据中心
为数据中心代理下单、列出、延期、轮换凭据以及将 IP 加入白名单。
9 个端点住宅
按 GB 购买住宅流量,通过您自己的网关主机名提供服务,并获取用量报告。通过子用户转售在单独的章节中介绍。
17 个端点子用户
转售您的住宅流量。在服务下创建子用户,向其划转或从其收回流量(GB),生成其代理字符串,并根据其自身的用量报告向其计费。
12 个端点ISP
为 ISP 代理下单、列出、延期、更改密码以及将 IP 加入白名单。
9 个端点移动
订购移动代理、轮换出口 IP、设置操作系统签名、将 IP 加入白名单以及下载 OpenVPN 配置。
14 个端点指纹
在数据中心和 ISP 代理上开启或关闭操作系统/浏览器 TCP 指纹(p0f),或切换配置文件。
4 个端点