The Ringover API allows you to connect your business tools and automate your communication processes. In this guide, you will learn how to diagnose and resolve access issues with the Ringover API to quickly restore the proper functioning of your integrations.
1. Perform initial diagnostics and identify errors
First of all, analyse the basic parameters of your connection to the API to quickly identify the source of the problem:
- Validate the target URLs of your requests (for example,
/Leads/globalsearch). - Test your API key on several different endpoints to check its overall validity.
- Check the validity of your authentication tokens and credentials.
- Thoroughly analyse error messages returned by the API to understand the nature of the block.
2. Compare Test and Production environments
Configuration discrepancies between your test (dev) and production environments can block your requests:
Test environment validation
- Check that your test server IP addresses are not blocked by specific development or staging rules.
- Test your requests from other networks to isolate the fault and identify any local blocks.
- Retrieve the Cloudflare Ray ID generated during errors to assist support investigations.
Production environment validation
- Rigorously compare the production configuration with the test configuration to spot any differences in credentials or tokens.
- Check that no specific IP block is affecting your production servers.
- Gather the precise error details (HTTP codes, JSON responses) specific to production.
➡️ Comparison checklist (Prod vs Test) :
- Credentials and authentication methods used.
- IP address allowlists.
- Network security and firewall rules.
- Permissions assigned to the account.
- Target endpoint URLs and request formats.
3. Check network security and IP reputation
Network security measures from Ringover or your infrastructure can block API calls:
- Ensure your server's IP address is not associated with a risky network or identified as malicious (IP reputation).
- Fix any network misconfigurations on your firewalls or routers that trigger unexpected blocks.
- Confirm the allowlisting of your IP addresses directly with your network infrastructure or hosting provider.
4. Check permissions and account configuration
Certain API features require specific access rights on your Ringover account:
- Confirm that your Ringover plan or account type supports API access.
- Enable all necessary write permissions for data modification, addition, or deletion operations.
- Check the specific access rights required for the targeted feature or endpoint.
5. Prepare the information to provide to technical support
If you cannot resolve the issue, prepare a comprehensive file for our support team to speed up the analysis:
- Note down the exact HTTP error code (for example, a 403 Forbidden code).
- Retrieve the Cloudflare Ray ID associated with the failed request.
- Provide the exact request including the URL, headers, and parameters sent.
- Take screenshots of error messages or logs from your developer console.
- Provide the timestamp (precise date and time) of the connection attempt.
- Provide a clear comparison between a working request and a failing request.
🎉 You now know how to diagnose and resolve access issues with the Ringover API to safely restore your integrations!