API API

Authentication

Every API request must be authorized by an access token, please find the necessary information below:

Option 1

Generate the access token by using the /authentication-token endpoint. The request body must contain the following:
- email
- password
- client_id - which can be obtained from the customer's details page (in the Portal), under the label "API secret (client_id)"
After generating the token, it can be used to authorize operations on the API. For this, the "Authorization" header must be set, having the value "Bearer" followed by the token generated in the previous step.
Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ...

Option 2

Call the API without the need for authentication by providing the following:
- client_id - which can be obtained from the customer's details page (in the Portal), under the label "API secret (client_id)"
- api_key - a user-specific static API token, which can be requested from Resale Partners Support
Usage - Set the following request headers in each request:
- CLIENT-ID - with the value of the client_id
- AUTH-TOKEN - with the value of the api_key

Allowing access to users

In order to allow a user to use the API, they must first have the "Is allowed to login to the API" checkbox set. This can be done from the Portal user edit page.
The reseller must add the allowed IP addresses to the whitelist in order to grant access to the API for any user with that IP. This can be done from the Portal settings page, in the "Whitelist" section, by clicking the "Add" button.

API rate limits

When making requests to an API, it is important to be aware of rate limits that may be in place. Rate limits are set by the API provider to ensure fair usage, protect server resources, and maintain optimal performance for all users. If you encounter a situation where your requests are being rate limited, it means that you have exceeded the allowed number of requests within a certain time period.

When a request is rate limited, the API server will respond with a specific HTTP status code (429 Too Many Requests) to indicate that your request has been temporarily throttled. Additionally, the response headers will provide information about the rate limit, including the total number of requests allowed, the number of remaining requests within the current time window, and the time when the rate limit will reset.