Error Handling

Effectively handle errors returned by the API using standardized error codes and messages, enabling graceful error recovery and troubleshooting.

Error handling is a crucial aspect of any API integration, ensuring that clients receive meaningful responses when encountering issues during their interactions with the system. The Braid API employs a robust error-handling mechanism, providing clear and informative messages to guide clients in troubleshooting and resolving issues effectively. This mechanism encompasses various HTTP status codes, each signaling a specific condition or outcome, along with detailed explanations to aid in understanding the encountered error.

When interacting with the Braid API, clients may encounter several common HTTP status codes, each serving as an indicator of the outcome of their request. For instance, a status code of 200 OK is returned for successful HTTP requests, indicating that the requested operation was completed successfully. This applies to standard HTTP methods such as GET, PATCH, DELETE, and PUT, where the response content may vary based on the specific request method used.

Similarly, a status code of 201 OK is returned for successful POST requests, where the response includes an entity describing or containing the result of the action. On the other hand, a status code of 204 OK signifies that there is no response for a successful request, typically seen when the request does not require a response body.

However, not all interactions with the Braid API result in successful outcomes. Clients may encounter errors due to various reasons, such as authentication issues, insufficient permissions, or resources not found. For instance, a status code of 401 Unauthorized is returned when the request requires user authentication or invalid credentials are provided. Similarly, a status code of 403 Forbidden indicates that while the server understood the request, it is refusing to fulfill it, typically due to insufficient permissions even after authentication. Moreover, a status code of 404 Not Found is returned when the server has not found anything matching the requested URI (Endpoint), indicating a potential issue with the provided URL or the non-existence of the requested resource.

The following table summarizes the HTTP status codes used in error handling within the Braid API, along with detailed explanations for each status code:

HTTP Status Code	Reason	Detailed Explanations
200	OK	This is the standard response for successful HTTP requests. The actual response will depend on the request method used. This will apply to GET, PATCH, DELETE, and PUT requests.
201	OK	This is the standard response for successful HTTP requests. The actual response will depend on the request method used. In a POST request, the response will contain an entity describing or containing the result of the action. This code will only apply to POST requests.
204	OK	This is if there is no response for a successful request.
401	Unauthorized	The request requires user authentication. Invalid credentials were provided, or the user doesn’t have permission to perform the requested operation.
403	Forbidden	The server understood the request, but is refusing to fulfill it. Authorization doesn't help here.
404	Not Found	The server has not found anything matching the requested URI (Endpoint). This could be a wrong URL or the resource doesn’t exist.