WHMCS set up guide - Realtime Register!

WHMCS set up guide
This guide helps you setting up your WHMCS preferences to enable a strong and effective connection between WHMCS and
Realtime Register. To install the WHMCS module you need to have administrator rights within WHMCS.
Version 1.0
1
Activating the Realtime Register module within WHMCS
1.1
Login at WHMCS
1.2
Unzip the Realtime Register module and upload it to your root directory
<whmcs root directory>/modules/registrars/realtimeregister/
Please remove the standard module first and upload the new files from the unzipped
Realtime Register folder.
1.3
Create your admin, billing and tech handle inside the Realtime Register domain
manager. You can manage these handles afterwards through WHMCS
1.4
Activate the uploaded Realtime Register module within WHMCS
Setup => Products/Services => Domain Registrars => Activate Realtime Register
1.5
Configure the module and set the most important settings
Setup => General Settings => Products/Services => Domain Registrars
Here you see an overview of the registrars. Please click on ‘Configure’ of the Realtime
Register module.
2
Configuration settings
Below you find instructions for each setting which you can set in the config within
WHMCS.
2.1
Realtime Register Account
Please enter your Realtime Register credentials
General settings WHMCS module
Activate general settings if you want to test, debug or receive debug test reports.
Create your Registration Profile
You can choose to create a standard set of handles which are used for Admin, Billing and Tech. If you do not use this option, the registrant details will be used.
2.1
2.2
2.3
2.4
2.2
Use the Realtime Register availability check (optional)
Realtime Register’s availability check offers:
+ Unlimited availability checks (fair use policy applies)
+ Support for all TLD’s
+ Stable and reliable performance
In order to use Realtime Register’s availability check over the WHMCS WHOIS services,
please use the instructions below.
Activation instructions:
‘Use Realtime Register WHOIS’ inside module configuration and replace domainchecker.
tpl inside your template (theme) directory with: /realtimeregister/domainchecker/templates/default/domainchecker.tpl
Please NOTE!
The template is optimized for the ‘default’ theme. If you want to use the Realtime
Register WHOIS with any other template (theme), please replace the variables below
within domainchecker.tpl.
$available
$invalid
$error
$invalid
$availabilityresults 2.3
----> ----> ----> ----> ----> $rtravailable
$rtrinvalid
$rtrerror
$rtrinvalid
$rtravailabilityresults
Synchronization Options
Synchronize Domain Status (Recommended)
Activate this option to synchronize the domain status between WHMCS and Realtime
Register.
Synchronize Expire date (Required)
Activate this option to synchronize the expiry date between Realtime Register and
WHMCS. Realtime Register is leading.
Synchronize Due date (Not recommended)
Activate this option to synchronize the due date between Realtime Register and
WHMCS. The due date will be the same date as the Expiry date.
Only activate this option if you are sure and backup before proceeding.
Synchronize Next invoice date
Activate this option to synchronize the next invoice date between WHMCS and Realtime
Register. Realtime Register is leading.
Due date offset (extra setting if Synchronize Due date is active)
The due date which will be calculated based on Expriry Date +/- amount of days you will
type in.
Next invoice date offset (extra setting if Synchronize next invoice date is active)
The next invoice date which will be calculated based on Expriry Date +/- amount of days
you will type in.
Cron script limits
Set the maximum number of domains which will be processed when the cron runs.
Restriction for Realtime register cron scripts
Enter trusted IP addresses to run Realtime Register cron scripts or leave it empty to
allow run scripts from any IP. Please use the comma to separate multiple IP addresses.
2.4
Cron script Installation
Set required cron job
New module can synchronize different domain information using its own
actions. The cron script URL is following:
<your_url>/modules/registrars/realtimeregister/cron/all.php
This way it will execute all actions. You have also ability to disable
some actions which you do not want to perform using URL GET parameters.
There’re currently 5 types of actions:
+ Synchronize Auto Renew (syncautorenew)
+ Synchronize Pending Status (syncpendingstatus)
+ Synchronize Domain Information (syncdomaininfo)
+ Simulate Expiration (simulatexpiration)
+ Synchronize Domain Transfer (syncdomaintransfer)
Do you want to disable some functionality?
Cron URL with disabled action is going to look like:
<your_url>/modules/registrars/realtimeregister/cron/all.php?<operation1>=0
For example, if you want to disable Simulate Expiration and
Synchronize Auto Renew actions and use Synchronize Domain Information plus
Synchronize Pending Status actions, your URL should look as:
<your_url>/modules/registrars/realtimeregister/cron/all.php?simulatexpiration=0&syncautorenew=0
Advice cron job:
Recommandation: we recommend to run the cron job daily to keep your domains
in sync. More info about cronjobs: http://en.wikipedia.org/wiki/Cron
WHMCS default cron job:
This information could be also synchronized using WHMCS domains sync script
but we advice you to use Realtime Register cron script.
Important: Do not use both scripts!
For more information about WHMCS default cron script see:
http://docs.whmcs.com/Domains_Tab
3
FAQ
WHMCS default Auto renew setting
In order to set default Auto Renew value (either ON or OFF) for new domains inside
WHMCS go to Setup => General Settings => Domains (tab)
and tick/untick checkbox next to “Default Auto Renewal Setting”.
Please NOTE!
For .NL and .DE extensions Auto Renew value is always turned ON at Realtime Register
side, no matter what you set inside WHMCS. Still, this value could be set to OFF
remotely by running “Simulate Expiration” action (see cron script configuration and
actions detailed information for more info). It processes your Realtime Register domains
which has expiry date in 15 days or less and disable Auto Renew at Realtime Register
side in case Auto Renew is disabled inside WHMCS.
Explicit renewals support
The registries of the following TLDs do not support explicit renewal:
.IT, .FR, .BE, .AT, .AM, .FM, .RU, .LI, .CH.
That’s why after renew operation is requested, we make sure that Auto Renew is
enabled at both Realtime Register and WHMCS. This way after expiry date is reached,
domain will auto renew (expiry date will get +1 year at Realtime Register) and domain
sync script (either WHMCS or our’s) will sync the expiry date (due date and next invoice
date) of domain.
Registration of .FR, .RE, .PM, .TF, .WF and .YT TLDs
To properly register .FR, .RE, .PM, .TF, .WF and .YT TLDs,
please add next line into <whmcs root directory>/includes/additionaldomainfields.php,
which will allow to provide birth place country code for our service:
$additionaldomainfields[“<tld lowercase>”][] = array(“Name” => “Birthplace Country”,
“Type” => “text”,”Size” => “2”,”Default” => “<default country code>”,”Required”
=> false, “Description” => ‘Please, enter your birth country code (use <a href=”http://
en.wikipedia.org/wiki/ISO_3166-1_alpha-2”>ISO 3166-1 alpha 2</a>)’);
Before you copy this line, replace:
1. <tld lowercase> - with TLD you want to add additional field to, e.g. “.fr”;
2. <default country code> - with country code that has to be set by default;
Example:
$additionaldomainfields[“.fr”][] = array(“Name” => “Birthplace Country”, “Type” =>
“text”,”Size” => “2”,”Default” => “FR”,”Required” => false, “Description” => ‘Please,
enter your birth country code (use <a href=”http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2”>ISO 3166-1 alpha 2</a>)’);
Registration of SE and .NU TLDs
To properly register .SE and .NU TLDs,
please add next lines into <whmcs root directory>/includes/additionaldomainfields.php,
which will allow to provide Personal or organisation number and Vat number for our
service:
$additionaldomainfields[“.se”][] = array(“Name” => “Personal or organisation number”,
“Type” => “text”,”Size” => “20”,”Default” => “”,”Required” => false, ‘Description’
=> ‘Corporate identity number or personal identification number (for non Swedish, any
other unique identification number can be used instead)’);
$additionaldomainfields[“.se”][] = array(“Name” => “Vat number”, “Type” => “text”,”Size” => “20”,”Default” => “”,”Required” => false, ‘Description’ => ‘VAT registration
number (only for foreign legal entities within the EU who are registered to pay VAT)’);
$additionaldomainfields[“.nu”][] = array(“Name” => “Personal or organisation number”,
“Type” => “text”,”Size” => “20”,”Default” => “”,”Required” => false, ‘Description’
=> ‘Corporate identity number or personal identification number (for non Swedish, any
other unique identification number can be used instead)’);
$additionaldomainfields[“.nu”][] = array(“Name” => “Vat number”, “Type” => “text”,”Size” => “20”,”Default” => “”,”Required” => false, ‘Description’ => ‘VAT registration
number (only for foreign legal entities within the EU who are registered to pay VAT)’);
4
Contact
If you need any support to install or configure this WHMCS module, please send an
email to [email protected].