Error Handling & Troubleshooting

Welcome to the Error Handling & Troubleshooting guide for the Documint API. As with any robust system, errors can occur. Understanding these errors and knowing how to address them is crucial to a smooth integration process. This guide will help you navigate potential issues, decode error messages, and find solutions.

Common Error Responses

The Documint API uses standard HTTP status codes to indicate success or failure of an API request. Here are some of the most common error codes you might encounter:

• 400 Bad Request: Your request is invalid or improperly formatted.

• 401 Unauthorized: There's an issue with your authentication.

• 403 Forbidden: You don’t have permission to access the requested resource.

• 404 Not Found: The endpoint or resource you're trying to access doesn't exist.

• 429 Too Many Requests: You've exceeded the API's rate limits.

• 500 Internal Server Error: Something went wrong on our end.

JavaScript Code Sample for Error Handling

Here's a simple example using JavaScript (with the Fetch API) to make a request to the Documint API and handle errors:

In the above example, if the API returns a status code other than 2xx (e.g., 400, 401, etc.), the response.ok check will fail, and the error will be thrown.

Decoding Error Messages

When an error occurs, the API will often return a detailed error message. This can be invaluable for troubleshooting. Here's how you might extract and use this message:

In the modified example above, if an error status code is returned, we extract the error message from the JSON response and throw it.

Troubleshooting Tips

1. Check Your API Key: Ensure that you're using a valid API key and that it's correctly included in your request headers.

2. Examine Your Request: For 400 Bad Request errors, check your request payload and parameters. Ensure everything is correctly formatted.

3. Rate Limits: If you receive a 429 Too Many Requests error, you might be making requests too frequently. Review the rate limiting section of our documentation for guidelines.

4. Logs: Maintain logs of your requests and responses. This can be helpful in tracking down issues.

5. Stay Updated: We occasionally make updates to our API. Ensure you're using the latest version and have accounted for any changes.

Need Further Assistance?

If you've gone through these steps and still can't resolve the issue, feel free to reach out to our support team. Provide them with as much detail as possible, including any error messages and relevant logs, to expedite the troubleshooting process.

Thank you for using the Documint API. Our goal is to provide a seamless experience, and this includes assisting you through any bumps you might encounter. Always refer back to our documentation for the latest guidelines and best practices.