Addons for WHMCS

    WHMCS Registrar Plugin

    User Manual for WHMCS Registrar Plugin
    MrDomain

    Download from Github

    1 Introduction

    This is the user manual for the MrDomain's Registrar Plugin for WHMCS.

    This plugin adds the capability to WHMCS to register, transfer and renew domains using the MrDomain's API. It also adds additional services like contact updating and managing, whois privacy and others.

    1.1 Getting started

    The Registrar Plugin for WHMCS uses the MrDomain's API. You need to have a working API account.

    To activate the plugin you will need an API USername and API Password that you should have obtained from MrDomain's support team. For more information about the MrDomain's API, visit the online documentation.

    1.2 Disclaimer

    WHMCS is a registered trademark of WHMCS Ltd.. MrDomain isn't part or is otherwise affialiated to WHMCS Ltd.. You can get more information on WHMCS Software on its official website.

    2 Plugin installation

    To install the plugin, download the corresponding ZIP from our Github repository. Once download, unzip it and you should end up with a folder named dondominio. Copy this folder to your addons directory on your WHMCS installation, usually /path/to/whmcs/modules/registrars/.

    Once copied, access your administration panel and go to the registrar configuration screen on Settings > Products/Services > Domain Registrars. Locate an addon named DonDominio and click on Activate. Once activated, click on the Configure button and enter the required information in order to make the plugin work.

    Addons

    2.1 Plugin configuration

    The available settings are the following ones:

    Campo Valores Descripción
    API Username Text Your API USername
    API Password Text Your API Password
    VAT Number Field Dropdown The custom field that contents the VAT Number of your customers
    Owner Contact DonDominio ID Text Owner contact's ID
    Allow customers to modify Owner contact information Sí/No Allow customers to modify Owner contact information even if you have provided a Contact ID for it
    Admin Contact DonDominio ID Text Admin contact's ID
    Allow customers to modify Admin contact information Yes/No Allow customers to modify Admin contact information even if you have provided a Contact ID for it
    Tech Contact DonDominio ID Text Tech contact's ID
    Allow customers to modify Tech contact information Yes/No Allow customers to modify Tech contact information even if you have provided a Contact ID for it
    Billing Contact DonDominio ID Text Billing contact's ID
    Lock modifications Yes/No If enabled, locking transfers will also block domain modifications

    2.2 Custom field

    The MrDomain's API requires a VAT Number for each customer registering domains. The WHMCS Plugin includes a change to how WHMCS handles these fields in order for it to work properly.

    To enable this change, you need to edit the /includes/additionaldomainfields.php file included on your WHMCS 6 installation, or the /resources/domains/dist.additionalfields.php file included in your WHMCS 7 installation.

    At the end of this field you need to add this line:

    include(ROOTDIR . "/modules/registrars/dondominio/additionaldomainfields.php");

    Additionally, the plugin includes a system to get a custom field in the case that the method above does not work for any reason. This field will be added to the customer data and it's required on renewals and other operations.

    Addons

    To add this field, access your administrator panel and then click on Settings > Custom fields. On the form, add the following data:

    • Field name: VAT Number
    • Field type: Text field

    The rest of the fields can be left blank. Also, check the Required field and Show on the order form boxes.

    Addons

    Check the Plugin configuration section for more details about the plugin configuration fields.

    3 Using the plugin

    Once installed and configured you can begin using the plugin to register, transfer and renew domains.

    In order for WHMCS to use the plugin you need to configure each TLD to tell it to use the plugin. You can automate this task using our Addon for WHMCS, or follow these steps to do it manually:

    1. Go to Settings > Products/Services > Domain prices
    2. If you haven't created the TLD you want to use, add it normally
    3. Configure the prices using the Open prices link
    4. On the Autoregistration field choose DonDominio
    5. Click on Save changes to confirm these settings

    Addons

    From this moment this TLD will use the MrDomain's plugin to register, transfer and renew domains. This process will be transpatent for the user.

    3.1 Processing errors

    If any errors happen during domain registration, transfer o renewal, the order will remain as Pending. Click on the N pending orders link on top of WHMCS administration panel to see them.

    You can retry the process by clickin on Accept order for each one of them. If there are any further errors, you will find a description on the screen. If the operation is successful the order will change to active status and the domain will become active in WHMCS.

    3.2 Domain Sync

    The plugin includes a domain sync service for WHMCS. This process is automatic, provided you have configured the Cron tasks for WHMCS, as explained on their documentation.

    The sync service will update the status for domains that have transfer pending and the status (along with expiration date) for the rest of the domains in batches of 50. When all domains are updated, the process starts again from the first one.

    4 Additional services

    The Registrar Plugin for WHMCS includes additional services for customers, outside the ones provided on the administration panel.

    4.1 Whois Privacy

    Although WHMCS provides an option for this, it may conflict with the Modifications Lock in MrDomain. For this reason, the plugin includes a custom option to provide this service.

    In WHMCS 5.x This option will appear on the tab Management tools as WHOIS Privacy, on the domain details screen.

    In WHMCS 6.x This option will appear as a new action on the sidebar, under the Additional services block, as Whois Privacy.

    In both versions, clicking on this option will bring a new screen with a single button that allows to enable or disable this service. The changes apply immediately through MrDomain's API.

    Please note that not all TLDs allow Whois Privacy. Also, note that the behaviour of this button is configurable through the plugin settings. See the plugin configuration section for more information.