Guidelines
These guidelines apply to all REST API calls:
-
Authentication
- Every API request must include the
Authorization
header with your secret key. See API Authentication for details.
- Every API request must include the
-
Headers
- Set the appropriate
Content-Type
header for your payload. For JSON requests, use:Content-Type: application/json - For file uploads, use the correct media type (e.g.,
image/jpeg
).
- Set the appropriate
-
Error Handling
- Successful creations typically return HTTP status 201.
- A 404 indicates the resource is not found.
- Validation errors will return a JSON payload with error details.
Follow these guidelines to ensure a robust integration with our API.