This section explains how unsuccessful requests are handled by our API, the potential causes of such requests, and the consequences of maintaining a high ratio of unsuccessful to successful requests.
What is an Unsuccessful Request?
An unsuccessful request refers to any request that does not return a successful HTTP status code (2xx). These requests typically result from poor implementation practices or errors in the parameters sent.
Examples of Unsuccessful Requests
- Missing Parameters: When a request does not include all the required parameters.
- Invalid Parameters: When one or more parameters sent do not meet the criteria specified in the documentation.
- Undefined Requests: When a request is made that is not supported or documented by the API.
Consequences of Unsuccessful Requests
It’s important to note that while unsuccessful requests do not count against your credits, they are tracked in our system. A high ratio of unsuccessful requests compared to successful ones can have several repercussions:
- Penalties: A high number of unsuccessful requests may result in penalties, such as a decrease in your rate limit.
- Rate Limit Reduction: If the high error ratio persists, your rate limit may be adjusted downward, limiting the number of requests you can make within a certain period.
- Account Suspension: In extreme cases, where persistent and excessive misuse is detected, your account may be suspended or banned.
How to Avoid Unsuccessful Requests
To avoid having your requests marked as unsuccessful, follow these recommendations:
- Review the Documentation: Ensure that all requests you make are clearly defined and supported by the API.
- Validate Parameters: Before sending a request, verify that all parameters are present and meet the expected formats and values.
- Error Handling: Implement robust error handling to quickly capture and correct any issues with your requests.
Monitoring and Continuous Improvement
We recommend regularly monitoring your usage metrics to identify and correct any patterns of unsuccessful requests. Utilizing logging and analytics tools can help you quickly detect and resolve these issues, improving the performance and efficiency of your integration with our API.
This professional format is designed to ensure that your users clearly understand the implications and handling of unsuccessful requests in your API.
You’re only charged for successful responses—failed requests are free of charge!