OwlProxy OpenAPI 开发者速查手册
OwlProxy 代理服务 OpenAPI 接口快速参考 · 适合 AI 工具直接读取
本文档为 AI 快速参考:供大模型、代码助手等工具快速解析接口路径、方法及用途。详细请求/响应参数、示例以 接口文档 为准。
📥 下载纯文本版本 — 适合 AI 工具直接读取
获取方式:
- 浏览器下载:点击此处下载 llms-ai-reference.txt,或访问
https://api.owlproxy.com/owlproxy/doc/zh/server/llms-ai-reference.txt - 命令行获取:
curl https://api.owlproxy.com/owlproxy/doc/zh/server/llms-ai-reference.txt -o owlproxy-api.txt - 在线预览:浏览器中打开上述链接可查看原始文本(如遇乱码请设置编码为 UTF-8)
🔐 认证方式(必读)
认证说明
本 API 使用 HMAC-SHA256 签名验证。
请求头设置(每个请求必需)
| 请求头 | 说明 | 示例值 |
|---|---|---|
| x-date | 请求 UTC 时间,ISO 8601 格式 | 20240301T093700Z |
| x-host | 接口访问域名 | api.owlproxy.com |
| Content-Type | 资源 MIME 类型 | application/json |
| authorization | HMAC-SHA256 签名 | 见 调用说明 |
Authorization 格式
HMAC-SHA256 Credential={AccessKey}, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature={Signature}
签名计算步骤(规范请求、待签名字符串、SigningKey、Signature)及示例代码请参考 接口文档。
📡 基础信息
| 配置项 | 值 |
|---|---|
| 接口域名 | https://api.owlproxy.com |
| 路径前缀 | /owlproxy/(部分接口) |
| 响应格式 | JSON { code, msg, ts, data } |
| 成功状态码 | code=200 |
📚 API 功能分类
1️⃣ 静态IP服务
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 获取代理类型 | GET | /owlproxy/proxy/type | 获取支持的代理类型列表 |
| 获取静态IP地区 | GET | /owlproxy/static/region | 获取静态IP支持的地区列表 |
| 获取静态IP质量选项 | GET | /owlproxy/static/quality | 获取静态IP质量选项 |
| 获取静态IP服务商 | GET | /owlproxy/static/provider | 获取静态IP服务商列表 |
| 获取静态IP套餐 | GET | /owlproxy/static/package | 获取静态IP套餐列表 |
| 购买静态IP套餐 | POST | /owlproxy/static/order | 购买静态IP套餐 |
| 根据订单号获取IP信息 | POST | /owlproxy/static/ipinfo | 根据订单号获取IP信息 |
| 获取静态IP列表 | POST | /owlproxy/static/list | 获取用户静态IP列表 |
| 修改静态IP备注 | POST | /owlproxy/static/remark | 修改静态IP备注 |
| 静态IP续费 | POST | /owlproxy/static/renew | 静态IP续费 |
| 批量计算续费价格 | POST | /openApi/vcProxy/batchCalculateRenewPrice | 批量计算多个IP的续费价格 |
| 设置静态IP自动续费 | POST | /owlproxy/static/autoRenew | 设置静态IP自动续费 |
| 静态IP订单列表 | POST | /owlproxy/static/orderList | 获取静态IP订单列表 |
2️⃣ 动态代理服务
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 查询动态流量余额 | GET | /owlproxy/dynamic/balance | 查询动态代理当前流量余额 |
| 获取动态IP套餐 | GET | /owlproxy/dynamic/package | 获取动态IP套餐列表 |
| 购买动态IP套餐 | POST | /owlproxy/dynamic/order | 购买动态IP套餐 |
| 获取动态IP提取地区 | GET | /owlproxy/dynamic/region | 获取动态IP提取地区列表 |
| 获取动态IP提取线路 | GET | /owlproxy/dynamic/line | 获取动态IP提取线路 |
| 动态IP提取 | POST | /owlproxy/dynamic/extract | 提取动态IP |
| 动态IP自动续费订单 | POST | /owlproxy/dynamic/autoRenewOrder | 获取动态IP自动续费订单 |
| 动态IP设置自动续费 | POST | /owlproxy/dynamic/setAutoRenew | 设置动态IP自动续费 |
| 动态IP订单列表 | POST | /owlproxy/dynamic/orderList | 获取动态IP订单列表 |
3️⃣ 回调管理
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 购买和续费静态IP套餐支付结果回调 | POST | 回调地址 | 支付结果回调通知 |
回调需在 WEB 端配置回调地址,详细字段与示例见 接口文档。
📋 回调通知事件
| 事件 | 说明 |
|---|---|
| 静态IP购买成功回调 | 支付成功后触发回调,通知订单状态变更 |
| 静态IP续费成功回调 | 续费支付成功后触发回调 |
🚦 常见错误码
| 错误码 | 说明 | 处理建议 |
|---|---|---|
| 200 | 成功 | - |
| 2031 | 无效的密钥 | 检查 AK/SK |
| 2032 | 请求头缺少 Authorization | 补充签名请求头 |
| 2019 | 验证签名失败 | 按 接口文档 核对签名 |
| 100000 | 请求参数不正确 | 检查参数是否符合要求 |
| 100003 | 缺少请求头 Authorization | 检查请求头 |
| 100004 | 无效的签名 | 检查签名计算 |
| 100005 | 验证签名失败 | 确认签名方式正确 |
更多错误码见 错误码说明。
💡 使用建议
提示
- 认证安全:妥善保管 AK/SK,勿在客户端硬编码,定期更换。
- IP提取:动态IP提取后请及时使用,IP存在有效期限制。
- 套餐选择:根据业务需求选择合适的套餐类型和地区。
- 回调配置:建议配置回调地址以获取订单状态变更通知。
- 流量监控:定期查询流量余额,避免服务中断。
📖 相关文档
文档版本:速查版
内容以 OpenAPI 接口文档 为准