Error Handling
Errors
The BriteAPI uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted), and codes in the 5xx range indicate an error with BriteAPI servers (these are rare).
The BriteAPI uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request – Your request is invalid |
| 401 | Unauthorized – Your API key is wrong |
| 403 | Rate Limit Exceeded – The API is rate limited to 100 requests per second, per client. Try again later. |
| 404 | Not Found – The specified resource could not be found |
| 405 | Method Not Allowed – You tried to access a resource with an invalid method |
| 406 | Not Acceptable – You requested a format that isn't JSON |
| 410 | Gone – The resource requested has been removed from our servers |
| 500 | Internal Server Error – We had a problem with our server. Try again later. |
| 503 | Service Unavailable – We're temporarily offline for maintenance. Please try again later. |
These error codes help you identify and troubleshoot issues when interacting with the BriteAPI. When you receive an error response, refer to the corresponding error code and its meaning to understand the nature of the problem.