x-api-key header.
Base URL
What you can do with the API
With the API, you can:- Retrieve account information such as credits, line count, and server details
- Create, update, extend, suspend, unsuspend, and remove lines
- Create trial lines when your account is eligible
- List available bouquets and inspect line information
- Estimate upgrade or extension costs before performing an action
- Integrate reseller operations into your own applications and automations
Quick start
If you are new to the API, this is the fastest path to your first successful integration:1
Create an API key
Create an API key by following our guide.
2
Authenticate requests
Learn how to authenticate requests in
Authentication.
3
Send your first request
Send your first request using Making Requests.
4
Review production basics
Review Protocol, Rate Limiting, and
Error Handling before moving to production.
Documentation summary
The documentation is organized into two main parts: narrative guides and the endpoint reference.Getting Started
- Introduction: overview of the API, quick start path, and documentation map
- API Changelog: recent API additions, improvements, fixes, deprecations, and breaking changes
API Overview Guides
- API Keys: how to create, store, rotate, and safely use API keys
- Versioning: how API versions work and which changes are considered breaking
- Protocol: HTTP methods, HTTPS requirements, headers, JSON payloads, and status code basics
- Authentication: how to send the
x-api-keyheader and troubleshoot authentication failures - Pagination: how
offsetandlimitwork for paginated list endpoints - Making Requests: first request walkthrough using cURL and the
/v1/meendpoint - Rate Limiting: request quotas, rate limit headers, and retry guidance
- Request IDs: where to find
x-request-idand how to use it for debugging and support - Error Handling: error response formats, common error codes, and retry guidance
API Reference
The API reference contains endpoint-level details generated from the OpenAPI document, including parameters, request bodies, response schemas, and example responses. The current reference is organized around these areas:Overview: account-level information such asGET /v1/meLine Management: create, list, update, extend, upgrade, suspend, unsuspend, and remove linesBouquets: list available bouquetsCredits System: credit-related account operations and legacy credit endpoints
Recommended reading order
If you are integrating the API for the first time, read the documentation in this order:1
Create or review your API key
Start with API Keys.
2
Learn how authentication works
Continue with Authentication.
3
Understand the API protocol
Read Protocol.
4
Send your first request
Follow Making Requests.
5
Understand failure responses
Review Error Handling.
6
Review request limits
Read Rate Limiting.
7
Move to the endpoint reference
Finish with the endpoint you want to use in the API reference.