Handling errors
How to handle and understand errors in API responses.
When something goes wrong with a request, the response provides important informations to help to understand what happened and how to fix it.
{
"code": 1234,
"message": "Exception error message",
"info": {
"comment": "additional extra info",
"userId": 123,
"transactionId": "456-abc"
}
}
Version 2.0 returns specific HTTP status codes for errors, the table below explain those:
Code | Error type |
---|---|
401 | Authentication Error |
403 | Endpoint Access Error |
404 | Endpoint Not Found Error |
405 | Method Not Allowed Error |
500 | Application Error |
Response attributes
code: an Ingresse's internal code that helps to identify a specific error.
message: a human readable message that describes the problem.
info: an object with all data involved in the detection of the problem.
Updated over 5 years ago