Integration Guide
Authentication
All routes are protected by API Keys. This means that every request to a protected route must include a valid API key in its headers, or the request will be unauthorized.
Managing API Keys
You can manage your existing API keys in the option API Keys that is available in your profile:
- View or relabel existing keys
- Rotate (re-roll) a key if you want to invalidate the old one and generate a new one for security purposes
⚠ Warning
Remember to keep your API keys confidential, as anyone with the key can make requests on your behalf.
API Rate Limiting and Retry Mechanism
Overview
API routes are protected with rate limiting to prevent excessive requests in a
short time. When the rate limit is exceeded, the server responds with a 429 Too Many Requests status code and includes a Retry-After header to inform
the client when they can safely retry the request.
429 - Too Many Requests Response
When the rate limit for an API endpoint is exceeded, the server will respond
with a 429 Too Many Requests status code and the following header:
Retry-After Header
The Retry-After header specifies the amount of time you should wait before
making another request. It can be provided in two formats:
Seconds: A numeric value indicating the number of seconds to wait before
retrying the request.
Example:
Code
This means you should wait 120 seconds (or 2 minutes) before retrying the request.
HTTP Date: A specific date and time (in UTC) indicating when you can retry the request. Example:
Code