π General API Resources
Welcome to the Esadax API reference. Here you'll find all the essential information you need to interact with our API, including how to authenticate, understand response statuses, and resolve validation errors.
π Authentication
All API requests must be authenticated using an API token. This is done by adding an Authorization header to your HTTP request.
β Header Format
Authorization: Bearer XXX
Replace XXX with your actual API token.
π About API Tokens
- API tokens are generated per user account.
- Each token can have custom permissions to limit access to specific areas of your account.
- This helps keep your integration secure by granting only the access thatβs necessary.
β‘οΈ Read more about managing API tokens
π¬ API Responses
Esadax uses RESTful principles and conforms to standard HTTP response practices. Every response from the API will include a relevant HTTP status code to indicate the success or failure of your request.
π HTTP Status Codes
| Code | Name | Description |
|---|---|---|
| 200 | OK | The request was accepted successfully. |
| 201 | Created | The resource was successfully created. |
| 202 | Accepted | The request was accepted and processing continues in the background. |
| 204 | No Content | The request was accepted, but there is no content to return. |
| 400 | Bad Request | There was an error with your request. Check the endpoint requirements and try again. |
| 401 | Unauthorized | Invalid API token. Read more. |
| 403 | Forbidden | The action is not permitted for this token or account. Check token permissions. |
| 404 | Not Found | The requested resource does not exist. |
| 405 | Method Not Allowed | The HTTP method used is not supported for this endpoint. |
| 408 | Request Timeout | There was a timeout on our end. Please contact support. |
| 421 | Service Not Available | We are undergoing maintenance. Try again later. |
| 422 | Unprocessable Entity | Validation error in your request. Review and try again. Read more |
| 429 | Too Many Requests | Rate limit exceeded. Read more about rate limits |
| 500 | Internal Server Error | Unexpected server error. Please contact support. |
| 502 | Bad Gateway | Temporary system issue. Please contact support. |
| 503 | Service Unavailable | System is currently unavailable. Please contact support. |
| 504 | Gateway Timeout | There was a timeout on our system. Please contact support. |
π More info on HTTP status codes can be found on Mozilla Developer Network.
π§ Validation Errors
Validation errors (HTTP 422) occur when your request payload doesn't meet the requirements for a given endpoint. This might be due to:
- Missing required fields
- Invalid data formats
- Incorrect parameters
Always double-check the API endpoint documentation to ensure your request body matches the expected format.
