Addons for WHMCS

    Installation

    User manual for our WHMCS Addon and Modules
    Version 2.2.0 - 28/07/2021
    MrDomain

    Download from Github

    1 Installation

    Download the ZIP from our Github repository. Once downloaded, unzip it and you will end up with a folder named src. Upload the contents of the folder inside your WHMCS root directory, usually /path/to/whmcs/ and accept and merge all the changes.

    1.1 Install individual modules

    Note Although it is possible to install individual modules, we recommend having the Addon installed for the use of any of the modules.

    To install a standalone module, download the ZIP from our Github repository. Once it's downloaded, unzip it and you should get a folder called src. It is necessary to access the modules folder where you can see the Addon and the rest of the modules that we offer. Copy the contents of the desired module folder into the src/modules/ folder of the WHMCS installation.

    Once the folder is copied, access the WHMCS administration panel to activate it. Please note that some modules like the Registrar Module need some configuration to work. Visit its corresponding section to finish its configuration.

    1.2 Update versions lower than 2.0.0

    To update the Addon it is necessary to download the corresponding ZIP file from our Github repository as if it were a totally new installation.

    1.3 Update from version 2.0.0

    Between these versions, it is not necessary to download the Addon ZIP. If you go to the Addon management panel, you will see an option to perform the update automatically.

    1.4 Update from version 2.1.4

    As of version 2.1.4 of the Addon, you will receive a notification in the Dashboard to make any update to it. You will also be able to see a widget with information about the Addon version and the option to update it automatically.

    1.5 Uninstallation

    To remove the addon, first go to Settings > Addon modules and locate DonDominio in the list. Click on the Disable button. All information stored in the database will be lost, except for the created TLDs and domains (and all associated settings).

    To completely delete the addon from your WHMCS installation, go to /path/to/whmcs/modules/addons, locate a dondominio folder and delete it.

    1.6 Multi-language support

    The addon and modules are available both in English and Spanish. It will automatically change depending on the language selected on your WHMCS administration panel. If you choose a different language from those two, the addon will default to English. For more information on language settings for WHMCS, check the documentation.

    2 Addon

    2.1 Configuration

    After the Addon installation, access the WHMCS administration panel and go to the addon configuration screen, on Settings > Addon modules. Locate an addon named DonDominio Manager Addon and click on the Enable button.

    Once activated, click on Configure and adjust the roles that will be able to use the Addon (usually, Full Administrator).

    Addons

    To start using the Addon, first it needs to be configured. The minimum required configuration is your MrDomain API details (username and password). To enter your API credentials, access Addons > DonDominio Manager Addon.

    Menu

    Since the configuration has not yet been entered, you will not be able to access any option until you provide this information. Enter your MrDomain API username and password in the appropriate fields and then click Save Changes. If the username and password are correct, the Addon will try to do an initial synchronization using the MrDomain API, an operation that may take a few minutes.

    API Settings

    If later you want to modify the MrDomain API username or password that you provided at this point, you can do so from the configuration screen.

    3 Registrar Module

    To install the Registrar Module, download the ZIP from our Github repository. Once downloaded, unzip it and you will end up with a folder named src. Upload the contents of the folder inside your WHMCS root directory, usually /path/to/whmcs/ and accept and merge all the changes.

    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 module work.

    Addons

    3.1 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 Yes/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

    3.2 Custom field

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

    WHMCS 7.x and 8.x

    You must copy the file /path/to/whmcs/modules/registrars/dondominio/additionalfields.php into /path/to/whmcs/resources/domains folder.

    If this file existed previously, you must cancel the operation and you must add the TLD fields manually following the instructions here: WHMCS Additional Domain Fields.

    If you are not sure how to proceed, please, contact our support team.

    To have the translations of the recorder module, it will be necessary to copy the following files into the folder /path/to/whmcs/lang/overrides:

    • /path/to/whmcs/modules/registrars/dondominio/lang/overrides/spanish.php
    • /path/to/whmcs/modules/registrars/dondominio/lang/overrides/english.php

    If these files already exist, the content of DonDominio/MrDomain's translations must be copied to the end of the existing files.

    Additionally, the module 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 Configuration section for more details about the module configuration fields.

    4 Provisioning Module

    To install the module, download the corresponding ZIP file from our Github repository. Once it's downloaded, unzip it and you should get a folder called src. Copy the contents of this folder to the WHMCS root directory, normally /path/to/whmcs/ and accept all changes.

    With these steps, the provisioning module will be installed in our application

    Important

    The SSL certificate provisioning module needs the Management Addon for its correct operation. You can see information about its installation here

    5 Addendum I

    5.1 Changelog

    All notable changes to this project will be documented in this section.


    v2.2.1 - 2021-09-07

    Changed

    • Update additional fields for registrar module.
    • Add translations for .es additional fields.
    • Use WHMCS update temporaly path for update Modules.

    v2.2.1 - 2021-09-06

    Fixed

    • Fix get owner Contact Type by Ident Number.

    v2.2.0 - 2021-07-27

    Added

    • New Provisioning Module for creating products within WHMCS from MrDomain's SSL products.
    • New section for the management of SSL Certificates and Products.
    • List of SSL certificates related to your API user.
    • List of products available from MrDominio's API.
    • List of imported products from MrDomain to WHMCS.
    • Daily synchronization of WHMCS products with MrDomain's products.
    • View with the detailed information of an SSL Certificate.
    • Form for the creation of WHMCS products from a MrDomain SSL Product.
    • View of the information of a certificate from the client side.
    • Change of validation method of alternative names of the certificate from the client and administration side.
    • Forwarding of alternative name validation email from the client and administration side.
    • Form to re-issue a certificate from the client and administration side.
    • Download of certificate in different formats on the client side.
    • Popup in dashboard to notify that the module installation is not finished.

    v2.1.7 - 2021-07-07

    Fixed

    • Adapt update system to be able to add DonDominio Modules,

    v2.1.6 - 2021-07-06

    Fixed

    • Fix administration section URLs.
    • Fix status change of Premium Domains.

    v2.1.5 - 2021-06-1

    Changed

    • Do not show errors if the request to check for new Registrar/Addon updates fails.

    Fixed

    • Fix error when updating domain prices if the currency code 'EUR' is duplicated.

    v2.1.4 - 2021-04-22

    Changed

    • Show available balance of API user.
    • Table with API user contacts.
    • Show more information when querying a domain.
    • To be able to activate / deactivate the premium domains from the Addon.
    • View for API user contacts.
    • Be able to forward the verification email to a contact.
    • Improved navigation within the Addon..
    • New Home page.
    • To be able to activate and configure the Registrar within the Addon.
    • Widget in WHMCS dashboard for update Addon/Registrar and access to Addon.
    • Popup in WHMCS dashboard for update Addon/Registrar.
    • To be able to synchronize the available TLDs and their pressure within WHMCS from the Addon.
    • Filters for the list of Price update.

    Fixed

    • Stay filters in Admin Domain lists pagination.

    v2.1.3 - 2021-04-06

    Changed

    • The registrar supports premium domains.
    • Optimization in the query of new versions of the module.
    • Interactive query of the connection with the API.
    • Improved navigation within the Addon.
    • List of deleted domains.
    • Filters for importing domains.
    • History of imported domains.
    • View for MrDomain/DonDominio domains.
    • To be able to transfer domains to MrDomain/DonDominio directly from the Domain Management.
    • If the custom field "Vat Number" is not found for the transfer of domains within the Addon, the one selected by the Registrar will be used.

    v2.1.2 - 2021-03-17

    Fixed

    • Now tables configured with row_format compact works as expected.
    • Operations with domains that involve Vat Number, now works correctly.

    Changed

    • More specific domain states.
    • More information in Addon status tab.

    v2.1.1 - 2021-02-26

    Fixed

    • Database consistency with non-nullable fields.

    v2.1.0 - 2021-02-23

    Changed

    • New Updater system. Update system now includes backups, robust permissions checking, rollback, etc

    v2.0.5 - 2021-02-22

    Fixed


    v2.0.4 - 2021-02-22

    Fixed

    • The module updater now does a more extensive permission check before updating.

    v2.0.3 - 2021-02-19

    Fixed

    • Fixed typo in parsing owner contact data. Now import & transfer domains works as expected.

    v2.0.2 - 2021-02-19

    Fixed


    v2.0.1 - 2021-02-11

    This release is based on the proposed changes in WHMCS 8 Upgrade Docs and fixes the Laravel upgrade issues (plugand get methods).

    Fixed

    • Registrar Module: Selector for VAT Number in Configuration now works correctly.
    • Addon Module: TLD Filter in Domains Management now works correctly.

    v2.0.0 - 2021-01-31

    This is a major release of the Dondominio - WHMCS Modules Integration. We have analyzed and verified all the functionality from scratch to make a better, faster, and more maintainable product. We have developed all the functionalities in order to make it 100% compatible with WHMCS 7 and 8 as well as we updated it with the new good practices that WHMCS 7 developer guide introduces.

    From Dondominio Team, we are very proud to announce Dondominio - WHMCS Modules Integration 2.0.

    Added

    • New project structure (from scratch) with namespaces.
    • Easier to install and configure.
    • Addon Module: New dashboard.
    • Addon Module: Update Check & Download Latest Updates.
    • Addon Module: Now checks API user/password in Registrar Module.
    • Addon Module: Now updates API user/password in Registrar Module.
    • Registrar Module: now tries to find Addon Module API username/password.
    • Dev: added developer tools (deploy and tests).

    Fixed

    • Addon Module: Collation bug.
    • Addon Module: Slow loading of Whois Proxy tab.
    • Addon Module, Registrar Module: Removed all the deprecated mysql_ functions.
    • Addon Module, Registrar Module: Removed all the deprecated select_query, update_query, insert_query, full_query functions.

    Changed

    • SDK: Unified in one place (/includes folder).
    • SDK: Updated to 2.0.0.
    • Addon Module: WHOIS System updated to WHMCS 7.0 good practices. Check it
    • Registrar Module: Suggestion Domains changed from Addon Module to Registrar Module in order to meet good practices. Check it
    • Additional Fields: the way it is installed has been changed to do it in a simpler and more standard way. Check it