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:

CodeError type
401Authentication Error
403Endpoint Access Error
404Endpoint Not Found Error
405Method Not Allowed Error
500Application 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.