Personal tools
Namespaces

Variants
Actions

NIC IT Registrar For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About NIC IT Registrar For WHMCS

NIC IT Registrar For WHMCS is a domain registrar module that enables automation of .it domains provisioning in your WHMCS.

The module has been enriched with mechanism that allows your clients to personalize each domain order and manage domains renewals directly in your client area.

  • Module Features:
✔ Set Domain As Expired X Days After Expiration
✔ Delete Domain X Days After Expiration
✔ Toggle Domain Auto Renewal
✔ Synchronize Domain Expiration Date And Status
✔ Synchronize Domain Transfer Status
  • Admin Area Features:
✔ Register/Transfer/Renew/Restore Domain
✔ Request Domain Deletion
✔ Toggle ID Protection
✔ Update Nameservers
✔ Modify Contact Details
✔ Get EPP Code
✔ Define Time After Expiry Date To Automatically Set Domain As Expired
✔ Define Time After Expiry Date To Automatically Request Domain Deletion
✔ Allow Clients To Change Domain Registrant Contact
✔ View And Modify:
✔ Legal Type
✔ Tax ID
✔ 'Publish Personal Data' Agreement
✔ '.IT Registrar Contract' Agreement
  • Client Area Features:
✔ Upon Order:
✔ Define Legal Type
✔ Enter Tax ID
✔ Accept 'Publish Personal Data' Agreement
✔ Accept '.IT Registrar Contract' Agreement
✔ Toggle ID Protection
✔ Toggle Domain Auto Renewal
✔ Manage Nameservers
✔ Update Contact Details
✔ Get EPP Code
  • General Info:
✔ Supports IDN
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.2 And Later

Installation and Configuration

This tutorial will show you how to successfully install and configure NIC IT Registrar For WHMCS.

We will guide you step by step through the whole installation and configuration process.

1. In the beginning make sure that you are the NIC.IT Reseller and your User account is active.
2. Log in to our client area and download the module.
NIC1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.

NIC2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

NIC2 1.png
4. When you install NIC IT Registrar For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/registrars/nicIT/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

NIC3.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

NIC4.png
6. Next, please move to yourWHMCS/resources/domains directory and find 'dist.additionalfields.php' file.

Find the following line:

$additionaldomainfields[".it"][] = array("Name" => "Legal Type", "LangVar" => "ittldlegaltype", "Type" => "dropdown",
"Options" => "Italian and foreign natural persons,Companies/one man companies,Freelance workers/professionals,
non-profit organizations, public organizations,other subjects,non natural foreigners",
"Default" => "Italian and foreign natural persons", "Description" => "Legal type of registrant",);  

Replace it with the code shown below:

$additionaldomainfields[".it"][] = array("Name" => "Legal Type", "LangVar" => "ittldlegaltype", "Type" => "dropdown",
"Options" => "1|Italian and foreign natural persons,2|Companies/one man companies,3|Freelance workers/professionals,
4|Non-profit organizations,5|Public organizations,6|Other subjects,7|Non natural foreigners",
"Default" => "1|Italian and foreign natural persons", "Description" => "Legal type of registrant",); 

Important: Introducing any changes into the original file is not recommended by WHMCS.
Note 1: Please refer to WHMCS official statement on any modifications performed in 'Additional Domain Fields' file here.
Note 2: In case you wish to translate or alter the types names, please refer to the WHMCS documentation here to learn how to do that. Please do not alter the names in the code above!

7. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area and go to 'Setup' 'Products/Servers' 'Domain Registrars'. Afterwards find 'NIC IT Registrar' and press 'Activate' button.

NIC5.png
8. Afterwards fill out registrar configuration with your details.

Important: 'Change Registrant' option refers to 'Italian and foreign natural persons' entity type only.

NIC6.png
9. At the end you have to add a cron job as shown below (each 24 hours suggested).
php -q /your_whmcs/modules/registrars/nicIT/cron.php 

Do not forget to replace 'your_whmcs' with your WHMCS root location.

You have just successfully installed and activated module NIC IT Registrar For WHMCS.

Management

NIC IT Registrar module allows you to manage TLDs in your WHMCS system.

In this short guide we will present you the possibilities of our module.

Management of TLDs

Adding new TLD is quite simple. To add it, go to 'Setup' 'Products/Services' 'Domain Pricing'.

Enter your TLD and choose 'NicIT' from 'Auto Registration' dropdown menu as shown on the screen below.
Here you can also decide which of the features you wish to offer along with the domain. Available addons:

  • DNS Management
  • Email Forwarding
  • ID Protection
  • EPP Code.

Then press 'Save Changes'.

NIC7.png
As you can see 'Open Pricing' field has appeared. Click on it and set up your pricing.
NIC8.png
In a newly opened window you can set your prices. Remember to save the changes!
NIC9.png
Finally set the pricing for enabled domain addons.
NIC9 1.png
Now your customers can start ordering new .it domains.

Ordering

Ordering .it domain goes alike ordering other domains, with one important difference.

During ordering your customers need to choose 'Legal Type' (Entity Type) and provide 'TAX ID' (VAT number).
We will discuss Legal Types in details in the next section.

NIC12.png
Keep in mind that a default WHMCS option 'Publish Personal Data' overrides addon 'ID Protection'.
Therefore if both options are selected, they will exclude one another. In order to avoid misunderstandings you may try to disable 'Publish Personal Data' option.
Move to Tips section to learn how it might be done.
NIC12 1.png
Review and checkout.
NIC12 3.png

Domain Management

Client Area

Manage domain, see overview with all the details.
NIC13.png
Add nameservers, use default or add custom ones.
NIC13 1.png
Manage available addons. Disable/enable available ones.
NIC14.png
Manage contact information depending on your entity type.

Contacts edition is always available and all three types can be edited: registrant, admin and tech.
The only exception is when the registered entity type is: 'Italian and foreign natural persons', then only two types: registrant and tech can be edited.
In this case also, if in the registrar configuration page in the admin area, the option to 'Change Registrant' is unselected, then registrant edition is completely blocked in the client area.

NIC14 1.png
Request sending the EPP code if you wish to transfer the domain.
NIC15.png

Admin Area

This is how an ordered domain looks like in the WHMCS admin area.

Here you can manage and modify domains according to your needs, like changing contact details or deciding whether to publish or not the personal data of domain owner.
Worth mentioning is 'Request Delete' feature which allows you to request domain deletion instantly.
The exact time of when a domain shall be deleted is declared by the admin in the module configuration.
Once the provided time passes the domain is automatically removed by cron.

NIC10.png
Now we will explain you how to correctly set Legal Type (Entity Type) and TAX ID (VAT number).

Depending on the chosen 'Legal Type', enter tax number in the 'TAX ID' field.

  • 'Italian and foreign natural persons' customer's address need to be set to Italy and field must contain a document number.
  • 'Non-profit organizations' field value must be set to 'n.a.'.
  • 'Non natural foreigners' enter VAT number in the previously mentioned field.

For all other types, simply type a VAT number or a numeric tax code.

NIC11.png

Tips

1. Deactivation of the module will remove your configuration settings at 'Domain Registrars'.
2. In order to remove the 'Publish Personal Data' option, open resources/domains/dist.additionalfields.php directory.

Find the below line and comment it out.:

$additionaldomainfields[".it"][] = array("Name" => "Publish Personal Data", "LangVar" => "ittlddata", "Type" => "tickbox",);

Keep in mind that deleting this line completely is never recommended.
Please refer to WHMCS official statement on any modifications performed in 'Additional Domain Fields' file here.

Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If one of the TLDs you have configured is unavailable, please make sure you have set up pricing in a default currency.
3. Problem with registering IDN domain may be caused by filling in already converted domain name.

The solution is filling in a domain name in UTF8 form, module converts it on its own.

4. If you encounter any problems with connection to NIC IT API, please make sure your server IP address is on the list of allowed addresses.
Registrar allows up to 5 IP addresses to be whitelisted.
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
NIC IT Registrar For WHMCS