Handling exceptions
All API errors have a known and predictable structure so the handling can be automated by the client requesting the server.
Error Reference
Property | Description |
---|---|
status | The final HTTP status code from the API Gateway in the Public API. For more information checkout the Full List of HTTP Errors. |
message | The exception message, usually in English and targeting the developer integrating in the platform. Should be handled by the client before being displayed directly to the end user. |
stackId | The unique ID for this exception, this helps the support team trace this exception in a deep diagnostic platform. |
details | The details regarding this exact error, can supply additional information and context for the error debugging. |
Example Error
Below there's an example for a 404 - Not found error response from the API.
{
"status": 404,
"message": "[404] The resource was not found. (stackId: f65a64d6-6f5f-4a0c-95ce-943416e79fbc)",
"stackId": "f65a64d6-6f5f-4a0c-95ce-943416e79fbc",
"details": {
"method": "GET",
"originalUrl": "/unknown/path"
}
}
Updated almost 4 years ago