This document will help you understand the various HTTP response codes that you may encounter while interacting with our API. Knowing these codes will help you handle responses effectively and troubleshoot any issues that arise.
HTTP Response Codes Overview
HTTP response codes are issued by a server in response to a client's request made to the server. They help indicate whether a specific HTTP request has been successfully completed and, if not, provide insight into what went wrong. Below is a list of common response codes with explanations.
2xx Success
200 OK: The request has succeeded. The meaning of the success depends on the HTTP method:
GET: The resource has been fetched and is transmitted in the message body.POST: The resource describing the result of the action is transmitted in the message body.
201 Created: The request has been fulfilled and has resulted in one or more new resources being created.
204 No Content: The server successfully processed the request, but is not returning any content.
4xx Client Errors
400 Bad Request: The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
401 Unauthorised: The request has not been applied because it lacks valid authentication credentials for the target resource.
403 Forbidden: The server understood the request but refused to authorise it.
404 Not Found: The requested resource could not be found but may be available in the future.
405 Method Not Allowed: A request method is not supported for the requested resource.
429 Too Many Requests: The user has sent too many requests in a given amount of time ("rate limiting").
5xx Server Errors
500 Internal Server Error: A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.
Handling Response Codes
Understanding and properly handling these response codes in your application will ensure a smoother interaction with our API. Below are some recommendations for handling various response codes.
2xx Success Codes:
200 OK: Process the response as expected.
201 Created: Confirm that the resource has been created, and store any provided resource identifiers.
204 No Content: No further action is needed.
4xx Client Error Codes:
400 Bad Request: Check and correct the request syntax or parameters.
401 Unauthorised: Ensure that your authentication credentials are correct and included in the request.
403 Forbidden: Confirm that you have the necessary permissions to access the resource.
404 Not Found: Verify the endpoint URL and the resource identifier.
405 Method Not Allowed: Ensure you are using the correct HTTP method for the endpoint.
429 Too Many Requests: Implement rate limit handling by pausing requests and retrying after the specified time.
5xx Server Error Codes:
500 Internal Server Error: Retry the request later or contact support if the issue persists.