Errors

To enhance security and facilitate easier debugging, the Kalixo API implements error logging and correlation key functionality. Each request and its corresponding response are logged into a database, ensuring a comprehensive record of API interactions. For improved traceability, a unique UUID is generated for each request and attached to the request header property "fhp-codehype-correlation-key."

This correlation key serves as a reference point and allows developers to easily track and debug specific requests and their associated responses. By including this key in the request header, developers can retrieve the corresponding logs from the database, enabling efficient troubleshooting and analysis.

Status codes

Here is a list of the different categories of status codes returned by the Kalixo API. Use these to understand if a request was successful.

Name
2xx
Type
Description
A 2xx status code indicates a successful response.
Name
4xx
Type
Description
A 4xx status code indicates a client error — this means it's a you problem.
Name
5xx
Type
Description
A 5xx status code indicates a server error — you won't be seeing these.

Error types

Whenever a request is unsuccessful, the Kalixo API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of the three error types supported by the Kalixo API — use these to understand what you have done wrong.

Error response

{
  "statusCode": "api_error",
  "message": "No way this is happening!?",
  "error": "Status code message"
}