Introducing the WHMCS plugin

RSS

Introducing the WHMCS plugin

Last updated May 10th, 2013

WHMCS is a client management, billing & support solution for online businesses. The SiteHost registrar module integrates with WHMCS and allows registration, renewal, and transfer of domains, and management of DNS. To get started using the plugin, you will need a working installation of WHMCS, the registrar module, and a valid API key.

Registrar module

The registrar module is distributed as a compressed folder that must be copied over to your WHMCS installation.

  1. Download the registrar module into a temporary directory.

  2. Ensure that the MD5 checksum of the tar file is correct.

  3. Decompress the module and copy the sitehost/ folder into the folder /path/to/whmcs/modules/registrars in your WHMCS installation.

Api key

The Api key is used to connect your WHMCS installation to your SiteHost account.

  1. Send an email to support@sitehost.co.nz. Include your SiteHost username (the same username used to log in to the SiteHost Control Panel), and the IP address where you are running your WHMCS installation.

  2. SiteHost support will generate an Api key and email it to you.

Set up the SiteHost domain registrar

When the module folder has been copied over, the SiteHost registrar module must be enabled and configured within WHMCS.

  1. Log into your WHMCS Administration area (e.g.: http://example.com/whmcs/admin)

  2. In the "Setup" menu, click "Domain Registrars". (see Figure 1)

  3. Find the "Sitehost" registrar and select the Activate Button.

  4. Copy the API key into the text box and click "Save Changes". (see Figure 2)

  5. The module has a script that should be run daily to ensure that expiry dates, next due dates and domain statuses are always up to date inside your WHMCS system. The command to run is displayed under the Domain Synchronisation Cron heading. Our knowledge base article contains information on how to set up a cron job to run on a SiteHost server, otherwise refer to the control panel or server documentation for the server running WHMCS.

  6. In order to use the DNS feature, we recommend setting the default name servers as the official SiteHost name servers which can be found in this article: (Setup > General Settings > Domains)

Figure 1 Domain Registrars

Figure 2 Domain Registrars

WHMCS also have instructions on how to configure a registrar.

Set up domain pricing

Prices must be set for registration, renewal, and transfer for all the TLD's that you want to offer clients.

  1. Log into your WHMCS Administration area (http://example.com/whmcs/admin)

  2. Go to Setup > Products/Services > Domain Pricing.

  3. Type any TLDs that you wish to allow registration/transfer/renewals in the boxes on the left (type a full-stop before the TLD eg, .co.nz - not co.nz). Click the checkbox for EPP code to turn it on (the UDAI / EPP code / Transfer Secret is required for domain transfers). EPP is another name for UDAI or Auth code. Click the checkbox under DNS Management if you would like to allow clients the ability to update their DNS records. If you would like domains to be automatically registered as soon as the invoice for the domain has been paid, select "SiteHost" from the Auto Registration select box. (see Figure 3)

  4. Click "Save Changes"

  5. Select "Open pricing" for the TLD you want to alter. Enter the prices for the operation type and term into the pricing matrix. (see Figure 4)

Figure 3 Domain Pricing

Figure 4 Domain Pricing

WHMCS also have instructions on how to configure domain pricing.


Next: Domain Registration →

Can we improve this article? Suggest an improvement to this article.

Suggest an Improvement

Thank you for helping us to improve this Knowledge Base article. Please type your suggestions below:

Still need help? Get in touch with us.

If you aren't able to find the help you need then please send us a question and we can help you further.