Ravelin uses conventional HTTP response codes to indicate 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 resulted from the provided request and
codes in the 5xx range indicate an error with Ravelin’s system.
A typical error response is shown below:
{
"status": 403,
"message": "Invalid Request: API Key Incorrect. Please check your credentials and try again"
}| HTTP Code | Meaning |
|---|---|
200 | OK -- Everything worked as expected. |
400 | Bad Request -- Often missing a required parameter, e.g. customerId. |
401 | Unauthorized -- Your API key is wrong. |
403 | Forbidden -- The resource requested is hidden for administrators only. |
404 | Not Found -- The specified resource could not be found. |
405 | Method Not Allowed -- Often you are not POSTing a request. |
406 | Not Acceptable -- You requested a format that isn't JSON. |
429 | Too Many Requests -- We're rate limiting your usage of the API. |
500 | Internal Server Error -- We had a problem with our server. |
503 | Service Unavailable -- We're temporarily offline for maintenance. |
504 | Service timeout -- We are temporarily offline or over capacity. |
For our recommendations on how to best respond to these error codes, please consult our Error Handling documentation or contact a Ravelin engineer.
Was this page helpful?