Partner API documentation
QuickStart
Our Partner API employs a secure authentication process to ensure that access is controlled and monitored.
Below you will find the required values that you need to authenticate your API requests. Detailed instructions on how to use API keys and JWT tokens in your requests will be sent out by our account manager.
Required values
To access our API, you will need the following values:
- base-paths
- your-api-key
- your-authentication-parameter-value
- authentication-endpoint
These values can be obtained by contacting our account manager.
Using API Keys and JWTs in Requests
JWT Tokens: Once you have your API key, you will use it to call our authorization endpoint ( authentication-endpoint).
Upon a successful request, a JWT token will be returned in a JSON response as a "token" value. For all requests to endpoints described in our OpenAPI documentation
Please note, the JWT token is valid for 1 hour. For most endpoints, the token can be reused until it expires. However, the "POST Invitation" endpoint requires a unique JWT for each request. If your JWT expires, simply re-authenticate to receive a new token.
Rate Limits and Quotas
Rate limits are an essential part of our API to ensure fair usage and stability. Please refer to the specific sections in this documentation for detailed information about the rate limits that apply to each endpoint.
Error Handling
Our API communicates errors effectively through standardized error codes and messages. This ensures that you can handle errors gracefully and understand the specific issue encountered during your API request. Common authentication-related errors include invalid credentials, expired tokens, and rate limit violations. Detailed information about error codes and messages can be found in the respective endpoint descriptions.
Any questions?
If you have any questions about our API, please reach out to our account manager. We are here to help you get started and provide you with the support you need to integrate our API into your platform.