Getting started
Getting started
Integration overview
The Open API provides wallet balance queries, dynamic proxy management, and static proxy management. It is designed for requests made by your server-side application.
API capabilities
| Capability | Description |
|---|---|
| Wallet | Query the USD balance available for purchases |
| Dynamic traffic | List products, purchase traffic, and query balances, daily usage, batches, and orders |
| Dynamic regions | Query available region codes by country, province/state, and city |
| Dynamic sub-accounts | Create and query sub-accounts, set traffic limits, enable or disable accounts, and generate connection credentials |
| Static proxies | Query regions, inventory, and quotes; purchase proxies, query resources, and renew them |
| Callback notifications | Send one notification when a static proxy purchase or renewal order reaches a terminal state |
API keys are created, renamed, enabled, disabled, and revoked through the web console. These operations are outside the scope of the business APIs in this documentation.
Service endpoints
Service endpoint
This instance uses https://api.ipfbs.com/gin as its Base URL. Append the request path from each API article to the Base URL. For example:
https://api.ipfbs.com/gin/open-api/v1/wallet/balance
Recommended integration sequence
- Obtain an API key for this instance.
- Follow the Quickstart to verify authentication and network connectivity.
- Confirm the required proxy capability and endpoint contract with the instance operator before implementing purchase requests.
- Implement error-code handling, timeouts, duplicate-submission protection, and sensitive-data protection.
- For another instance or environment, use its separately issued key and published Base URL.
Data security
API keys, proxy account names, proxy passwords, and complete connection credentials are sensitive. Do not place them in browser code, public logs, error pages, monitoring labels, or support ticket bodies.