Our RESTful API provides comprehensive access to all features:
- Authentication: API key required on every request
- Format: JSON requests and responses
- Methods: GET and POST (with Content-Type: application/json for POST)
Tip: Use Admin → API Tester to try endpoints with your API key.
Authentication
- Send both headers:
Authorization: Bearer YOUR_API_KEY
X-API-Key: YOUR_API_KEY - Do not place keys in query strings.
Rate Limiting
- Per‑minute rate limits are enforced per API key (configurable in Edit Profile).
- When exceeded, the API returns HTTP 429. Retry after one minute.
Common Headers
- Authorization: Bearer YOUR_API_KEY
- X-API-Key: YOUR_API_KEY
- Content-Type: application/json (for POST)
Error Codes
- 400 Bad Request – invalid or missing parameters
- 401 Unauthorized – invalid API key
- 403 Forbidden – not allowed
- 404 Not Found – resource not found
- 409 Conflict – duplicates or constraint violations
- 422 Unprocessable Entity – validation failed
- 429 Too Many Requests – rate limit exceeded