OwlProxy OpenAPI Developer Quick Reference
OwlProxy Proxy Service OpenAPI Interface Quick Reference · Suitable for AI Tools to Read Directly
This document is an AI Quick Reference: for large models, code assistants, and other tools to quickly parse interface paths, methods, and purposes. For detailed request/response parameters and examples, please refer to the API Documentation.
📥 Download Plain Text Version - Suitable for AI Tools to Read Directly
How to get:
- Browser Download: Click here to download llms-ai-reference.txt, or visit
https://api.owlproxy.com/owlproxy/doc/en/server/llms-ai-reference.txt - Command Line:
curl https://api.owlproxy.com/owlproxy/doc/en/server/llms-ai-reference.txt -o owlproxy-api.txt - Online Preview: Open the above link in browser to view raw text (if garbled, please set encoding to UTF-8)
🔐 Authentication (Must Read)
Authentication Description
This API uses HMAC-SHA256 signature verification.
Request Header Settings (Required for Each Request)
| Request Header | Description | Example Value |
|---|---|---|
| x-date | Request UTC time, ISO 8601 format | 20240301T093700Z |
| x-host | API access domain | api.owlproxy.com |
| Content-Type | Resource MIME type | application/json |
| authorization | HMAC-SHA256 signature | See API Guide |
Authorization Format
HMAC-SHA256 Credential={AccessKey}, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature={Signature}
For signature calculation steps (CanonicalRequest, StringToSign, SigningKey, Signature) and example code, please refer to API Documentation.
📡 Basic Information
| Configuration Item | Value |
|---|---|
| API Domain | https://api.owlproxy.com |
| Path Prefix | /owlproxy/ (for some interfaces) |
| Response Format | JSON { code, msg, ts, data } |
| Success Code | code=200 |
📚 API Function Classification
1️⃣ Static IP Service
| Interface | Method | Path | Description |
|---|---|---|---|
| Get Proxy Type | GET | /owlproxy/proxy/type | Get list of supported proxy types |
| Get Static IP Regions | GET | /owlproxy/static/region | Get list of regions supported by static IP |
| Get Static IP Quality Options | GET | /owlproxy/static/quality | Get static IP quality options |
| Get Static IP Service Provider | GET | /owlproxy/static/provider | Get list of static IP service providers |
| Get Static IP Package | GET | /owlproxy/static/package | Get list of static IP packages |
| Purchase Static IP Package | POST | /owlproxy/static/order | Purchase static IP package |
| Get IP Information by Order ID | POST | /owlproxy/static/ipinfo | Get IP information by order ID |
| Get Static IP List | POST | /owlproxy/static/list | Get user's static IP list |
| Modify Static IP Remarks | POST | /owlproxy/static/remark | Modify static IP remarks |
| Renew Static IP | POST | /owlproxy/static/renew | Renew static IP |
| Batch Calculate Renewal Price | POST | /openApi/vcProxy/batchCalculateRenewPrice | Batch calculate renewal price for multiple IPs |
| Set Static IP Auto-Renewal | POST | /owlproxy/static/autoRenew | Set static IP auto-renewal |
| Static IP Order List | POST | /owlproxy/static/orderList | Get static IP order list |
2️⃣ Dynamic Proxy Service
| Interface | Method | Path | Description |
|---|---|---|---|
| Query Dynamic Traffic Balance | GET | /owlproxy/dynamic/balance | Query current traffic balance for dynamic proxy |
| Get Dynamic IP Package | GET | /owlproxy/dynamic/package | Get list of dynamic IP packages |
| Purchase Dynamic IP Package | POST | /owlproxy/dynamic/order | Purchase dynamic IP package |
| Get Dynamic IP Extraction Region | GET | /owlproxy/dynamic/region | Get list of dynamic IP extraction regions |
| Get Dynamic IP Extraction Line | GET | /owlproxy/dynamic/line | Get dynamic IP extraction line |
| Extract Dynamic IP | POST | /owlproxy/dynamic/extract | Extract dynamic IP |
| Dynamic IP Auto-Renewal Orders | POST | /owlproxy/dynamic/autoRenewOrder | Get dynamic IP auto-renewal orders |
| Set Dynamic IP Auto-Renewal | POST | /owlproxy/dynamic/setAutoRenew | Set dynamic IP auto-renewal |
| Dynamic IP Order List | POST | /owlproxy/dynamic/orderList | Get dynamic IP order list |
3️⃣ Callback Management
| Interface | Method | Path | Description |
|---|---|---|---|
| Payment Result Callback for Purchasing and Renewing Static IP Packages | POST | Callback Address | Payment result callback notification |
Callback address needs to be configured on the WEB side. For detailed fields and examples, see API Documentation.
📋 Callback Notification Events
| Event | Description |
|---|---|
| Static IP Purchase Success Callback | Triggers callback after successful payment to notify order status change |
| Static IP Renewal Success Callback | Triggers callback after successful renewal payment |
🚦 Common Error Codes
| Error Code | Description | Handling Suggestion |
|---|---|---|
| 200 | Success | - |
| 2031 | Invalid key | Check AK/SK |
| 2032 | Authorization missing in request header | Add signature request header |
| 2019 | Signature verification failed | Check signature according to API Documentation |
| 100000 | Incorrect request parameters | Check if parameters meet requirements |
| 100003 | Missing Authorization request header | Check request header |
| 100004 | Invalid signature | Check signature calculation |
| 100005 | Signature verification failed | Confirm signature method is correct |
For more error codes, see Error Code Description.
💡 Usage Suggestions
Tips
- Authentication Security: Keep AK/SK properly, do not hardcode in client, change periodically.
- IP Extraction: Use dynamic IP promptly after extraction, IP has validity period limit.
- Package Selection: Choose appropriate package type and region based on business needs.
- Callback Configuration: It is recommended to configure callback address to get order status change notifications.
- Traffic Monitoring: Query traffic balance regularly to avoid service interruption.
📖 Related Documents
Info
| Document | Description |
|---|---|
| API Documentation | Complete interface description, request/response parameters and examples |
| Error Code Description | System error codes and solutions |
| Callback Interface | Callback types and example JSON |
Document Version: Quick Reference Version
Content is subject to OpenAPI API Documentation