This article explains how to access and test the Post Affiliate Pro API v3 (REST API). You will learn where to find the documentation, how to authorize, and how to execute test requests directly in your browser.
Where can I find the Post Affiliate Pro API v3 documentation?
You can access the complete API v3 documentation directly from your account:
https://YOURDOMAIN.postaffiliatepro.com/api/v3
Or navigate via Configuration > Tools > Integration > API v3 (REST API) > View API documentation. At the top of the page, you will also see your instance-specific API URL.
Authentication methods
API v3 supports two authentication methods. Choose the one that matches your use case:
- OAuth 2.0 (access token) - suitable for interactive use, development, or testing.
- Bearer token (API key) - suitable for server-to-server and long-term integrations.
After authorizing with either method, you can run test requests directly from the documentation.
How to test endpoints in the documentation
The documentation (Swagger UI) is interactive - you can review endpoints, parameters, and execute requests without writing code. Follow the steps below:
In the documentation, click Authorize and complete authorization using one of the methods described above (OAuth token or API key). When authorization is successful, the Authorize button remains highlighted in green.
Choose an endpoint, for example GET /affiliates, and click Try it out. You can use this endpoint to list affiliates and filter them using search parameters.
Fill in parameters as needed and click Execute. The request, response code, headers, and response body will appear below the form.
Rate limits
- Requests per minute: 100
- Unsuccessful login attempts: 10 per hour per username/IP (successful logins are not counted)
Successful responses include the following headers with current limits:
- X-RateLimit-Limit - maximum requests per minute
- X-RateLimit-Remaining - remaining requests in the current window
- X-RateLimit-Reset - Unix timestamp when the window resets
When the limit is reached, the response includes:
- Retry-After - seconds to wait before retrying
See also: Application and API requests limits.
API endpoints are rate limited. When the limit is exceeded, the server returns 429 Too Many Requests and provides the retry time.