Learn how to use the Partner Platform API. The majority of the functionality that you are familiar with on the platform is also available through the API.
Admins, affiliate managers, and affiliates can use API to get the same results they get from using the Partner Platform or Affiliate Area with the same access rights, limitations, and data scopes.
The API documentation starts with a general overview of the design and technology that have been implemented, followed by reference information about specific endpoints.
Our API has predictable, resource-oriented URLs and uses HTTP response codes to indicate API errors. JSON will be returned in all responses from the API.
| Status code | Description |
|---|---|
| 2xx | Success |
| 400 | Incorrect request |
| 401 | Authorization error |
| 403 | Forbidden |
| 404 | Page not found |
| 500 | Internal server error |
Throughout both user and affiliate APIs, a consistent list of data types is consistently used in parameters.
Basic
Basic parameters are passed to the API as simple name-value pairs.
For example, passing the integer "5" for a parameter named "baz" would be achieved by including the following in the API call:
&baz=5
Boolean
To pass a boolean parameter, enter a 0 to indicate "False" and a 1 to indicate "True".
Integer
Takes numbers. In some cases, floating-point numbers or negative values are allowed.