API Documentation

Category:

The Synergy Wholesale System includes fully featured API’s for Domain Names, cPanel Web Hosting, SSL Certificates, and SMS Messages with all documentation conveniently merged into a single document:

Please ensure you check this page regularly for changes and updates to our API documentation.

API Connection Information

We utilise the SOAP/WSDL connection method for authentication and interaction with the Synergy Wholesale API.  All queries to the API will require a resellerID and an apiKey to be passed through. In addition to this, you will also need to whitelist your connecting IP address within the Synergy Wholesale system.

The API Settings Page inside of the Synergy Wholesale system will allow you to enable/disable the API on a per-account basis, whitelist your IP address from where you’re making the API connection and retrieve (or re-generate) your API Key. To find this section:

  1. Login to your Synergy Wholesale system.
  2. In your menu, navigate to API Information.
  3. There you will see an Enable API button. Click on this to enable the API for your Synergy Wholesale account.
  4. You will now see your Reseller ID, API Key (including the option to re-generate the key) and your IP Whitelisting options.

If you want to learn more about integrating and using our WHMCS modules, please see our WHMCS category.