Common troubleshooting steps for finding and fixing domain/trust API connection issues after verifying there are no ongoing issues via the Statuspage.
Basic API troubleshooting
API key
Resellers find the API key in the Reseller Control Panel (RCP) account settings. Navigate to the API settings tab to verify or edit the current API key.
- Login to the RCP.
- Click on Account settings in the top right corner.
- Select the API settings tab. The API key is listed on the page at the top of the API key section.
Reseller account permission
Verify that the username you're sending is the primary reseller username on your account in the respective live or test environment and that you are not using a sub-user.
IP address allow list
Verify that the device you're connecting from uses an IP address you've granted permission.
- Login to the RCP.
- Click on Account settings in the top right corner.
-
Select the API settings tab. The IP access rules section is located below the API Key section.
Note: You can add a maximum of five IPs to the allow list. For more than five addresses, please get in touch with support.
Advanced API troubleshooting
Check the MD5 authentication
- Ensure that you have concatenated the XML content and the Private Key
- Ensure that you have performed an MD5 twice.
- Ensure that your HTTP Post implementation is not adding any extra information. Some implementations of HTTP Post add a NULL to the end of the HTTP Request. This is reflected in the MD5 and causes an authentication error.
- Ensure that the result is in lowercase before sending it to OpenSRS. Some MD5 algorithms put the MD5 hash in uppercase.
Some MD5 algorithms need to convert the string to bytes before generating the hash. Make sure this is done properly. You can test your script by performing an MD5 on the following text:
Text:
ConnecttoOpenSRSviaSSL
MD5 Result:
e787cc1d1951dfec4827cede7b1a0933Verify port access
When experiencing issues accessing the API, please run these commands from the server or computer you are connecting from. You can email the output to OpenSRS support for further troubleshooting if needed.
Note: The XML API port for production is 55443
curl http://icanhazip.com/s/ OR wget -q -O - http://icanhazip.com/s/
ping rr-n1-tor.opensrs.nettraceroute rr-n1-tor.opensrs.net
openssl s_client -connect rr-n1-tor.opensrs.net:55443
Response codes
You can find the details of the response code you receive from the call used in our official API guide documentation.
Was this article helpful? If not please submit a request here
How helpful was this article?
Thanks for your feedback!