Getting Started with the WHMCS Plugin
Once you have a working WHMCS installation, please follow these steps to get started:
1. Request the SiteHost Plugin and API Key
The first step is to request a copy of the SiteHost Registrar Plugin and a valid API Key. Send an email to email@example.com.
- Clearly state that you are setting up WHMCS and need both the WHMCS Plugin plus an API Key.
- Include your SiteHost username (the same username used to log in to the SiteHost Control Panel),
- Include the IP address of the server where you are running your WHMCS installation.
We will send you an email with both the WHMCS Plugin and an API Key.
2. Install the SiteHost Plugin
The SiteHost Registrar Plugin is distributed as a compressed folder that must be copied over to your WHMCS installation.
- Download the compressed file into a temporary directory.
- Ensure that the MD5 checksum of the tar file is correct.
- Decompress the module and copy the
sitehost/ folder into the folder
/path/to/whmcs/modules/registrars in your WHMCS installation.
3. Setup the SiteHost Domain Registrar
When the module folder has been copied over, the SiteHost Registrar Plugin must be enabled and configured within WHMCS.
- Log into your WHMCS Administration area (e.g.: http://example.com/whmcs/admin)
- In the "Setup" menu, click "Domain Registrars".
- Find the "SiteHost" registrar and select the Activate Button.
- Copy the API Key into the text box and click "Save Changes".
- 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. See 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.
- In order to use the DNS feature, we recommend setting the default name servers as the official SiteHost Name Servers: (Setup > General Settings > Domains)
WHMCS also have instructions on how to configure a registrar.
4. Setup Domain Pricing
Prices must be set for registration, renewal, and transfer for all the TLD's that you want to offer clients.
- Log into your WHMCS Administration area (http://example.com/whmcs/admin)
- Go to Setup > Products/Services > Domain Pricing.
- Type any TLDs that you wish to allow registration/transfer/renewals in the boxes on the left.
- Make sure you type a full-stop before the TLD eg:
.co.nz - not
- 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.
- Click "Save Changes".
- Select "Open pricing" for the TLD you want to alter. Enter the prices for the operation type and term into the pricing matrix.
WHMCS also have instructions on how to configure domain pricing.