The module facilitates its own API which can be used by your resellers to offer domains within various systems like WHMCS, HostBill, Blesta and others.
Just generate your own registrar module with just a couple of clicks, hand it over to your resellers and admire the sales they generate.

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

In the most recent versions of the module, you will find only one package that supports PHP 7.4 and later.

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

The content of the package to upload should look like this

File is located in 'modules/addons/domainsReseller/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

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'.

This folder is available at 'yourWHMCS/modules/addons/DomainsReseller/'.

Log in to your WHMCS admin area. Go to 'System Settings' → 'Addon Modules'. Afterwards, find 'Domains Reseller' and press 'Activate' button.

To do so click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

You can access your module at 'Addons' → 'Domains Reseller'.

To do so, find and open the "dashboard.yml" configuration file located at: (...)modules\addons\DomainsReseller\app\Config\UIElements\AdminArea directory.
There manage the dashboard elements' status by changing it from on to off according to your needs.

Here you may set up general options but still, you will be able to change them per single group. If you skip group settings, this configuration will be taken into account.

Global API related section:

• 'API Status ' - enable/disable Domains Reseller API.
  
• 'IP Addresses Restriction' - enable/disable restricting connection to Domains Reseller API only for IP addresses specified in the 'Allowed IP Addresses' field.
  
• 'API Requests Restriction' - enable option to restrict the number of API requests.
  
• 'Remove Logs After (days)' - define the number of days, log records older than the provided here number will be automatically deleted.

• 'Low Credit Notification' - a notification to your client will be sent when credit balance on client's account falls below entered value.
  You may view and edit the "Low Credit Notification" custom email template sent to clients at 'WHMCS' → 'System Settings' → 'Email Templates'. This email message is sent with the main WHMCS cron job.

• 'Low Credit Amount' - the number of credits, when reached a notification will be sent.
  

• 'Payment Type' options:
  • 'Pay After Registration' - resellers must have sufficient credits amount, but he is charged only after a domain has been successfully registered.
  • 'Pay After Order' - resellers must settle the payment just after the order, the amount due is taken from their account instantly.
    

• 'Refund Type' - defines behavior of the module upon unsuccessful domain registration.
  
  • 'Credits Only' - if selected, refunds are granted in form of credits only.
  • 'Refund Invoice' - if selected, refunds are delivered in form of credits along with a newly generated invoice.
  • 'Disabled' - if selected, refunds are not accepted.

• 'Allow Debits' - if enabled, resellers with no credits on their account will be allowed to order domains. In such a case, an invoice with 'Unpaid' status will be created for the ordered domain.
  
  • 'Maximum Debit Amount' - define the amount the reseller may use to order domains without credits.
    Important: The provided here amount is a total sum on all invoices with 'Unpaid' status that exist in your system.

• 'Default Registrant' - select default contact that will be used during registration. This option is available only if registrant contact uses WHMCS details.
  
• 'Default Admin/Tech/Billing' - select default admin that will be used for contact. This option is available only if Admin/Tech/Billing contact uses admin details from WHMCS.
  
• 'End User Allowed To Edit Contacts' - select which of the End Clients will be allowed to edit contact details. You may choose more than one.
  

Remember to submit the changes, once you have finished.

Start by creating the first group for your resellers. Use either of the buttons marked on the screen below.

• 'API Status' - enable/disable Domains Reseller API for Resellers assigned to this very group only.
  
• 'IP Address Restriction' - enable/disable restricting connection to Domains Reseller API only for IP addresses specified in the 'Allowed IP Addresses' field.
• 'API Requests Restriction' - enable the option to restrict the number of API requests.
• 'Show API Documentation' - toggle to allow resellers access to API documentation directly from their Reseller Area.
• 'Pricing Method' - choose the preferred pricing method from the two available:
  • 'Override' - you will be able to set pricing in the TLD's Tab.
  • 'WHMCS' - pricing is copied from that one set in WHMCS and you will not be able to set pricing in the TLD's Tab.
• 'Promotion Code' - provide a WHMCS promo code if you own one, the discount will be applied to every order covering pro code restrictions (WHMCS pricing method only.)
• 'Low Credit Notification' - turn on sending notifications to your client when credit balance on client's account falls below entered value.
  You may view and edit the "Low Credit Notification" custom email template sent to clients at 'WHMCS' → 'System Settings' → 'Email Templates'. This email message is sent with the main WHMCS cron job.
• 'Low Credit Level' - amount of credits, when reached a notification will be sent.
• 'Payment Type' options:
  • 'Pay After Registration' - resellers must have sufficient credits amount, but he is charged only after a domain has been successfully registered.
  • 'Pay After Order' - resellers must settle the payment just after the order, the amount due is taken from their account instantly.
• 'Refund Type' - defines behavior of the module upon unsuccessful domain registration.
  • 'Credits Only' - if selected, refunds are granted in form of credits only.
  • 'Refund Invoice' - if selected, refunds are delivered in form of credits only.
  • 'Disabled' - if selected, refunds are not accepted.
• 'Allow Debits' - resellers with no credits on their account will be allowed to order domains, invoice with 'Unpaid' status will be created for such order.
  • 'Maximum Debit Amount ' - define the maximum amount a reseller may spend on new domains (if there are no credits on the account).
    Important: This amount is a total of all the 'Unpaid' invoices created in your system.
• 'Default Registrant' - select default contact that will be used during registration. This option is available only if registrant contact uses WHMCS details.
• 'Default Tech/Admin/Billing' - select default admin that will be used for contact. This option is available only if Admin/Tech/Billing contact uses admin details from WHMCS.
• 'End Client Allowed to Edit Contact' - select which of the End Clients will be allowed to edit contact details. You may choose more than one.

Save the changes when ready.

Press 'Add Integration' to begin.

• Select the target platform for the submodule: WHMCS or Blesta

• Enter your module unique name

• Toggle on to allow downloading a file with additional fields required by the provider's registrar to register domains.
  Data typed in by End Clients will be correctly delivered by the provider to the domains' registrar. Learn more here.

• Type in a short description of the module, it will be visible on the activation page of the registrar

• Upload logo image, it will be visible on the activation page of the registrar

• Upload file with documentation if you have prepared any - you may use any format.

1. Edit its details (change logo, description etc.) at any time
2. Download domain additional fields
3. Download documentation if any has been provided
4. Download the integration package
5. Delete the integration

Press 'Assign TLD' button to begin.

In addition, if you put:

• -1 (minus one) value in the chosen field, then it will be treated as disabled. E.g. provide -1 for transfer pricing to completely disable the possibility of domain transfers with that TLD.
  Important: If you provide -1 value for registration pricing, then the whole TLD will be treated as disabled, including transfer and renewal pricing.
• 0 (zero) value in the chosen field, then it will be treated as free. E.g. provide 0 for registration pricing if you want to offer the selected TLD for free, but with paid transfers and renewals.
• any value above 0 (zero) will be of course treated as paid.

Your group configuration is now ready. If you have more groups, repeat these steps for each of them.
Remember that you may always edit the single group name or delete it if no longer needed. Just press adequate buttons to do so.

The 'config' file is located in: /Registrar_Name/components/modules/registrarname/config/registrarname.php. Open the file, at the bottom you will find a section: "All available TLDs" with a few examples added by default, fill in the list with your TLDs.
Below you can see what an exemplary list of TLDs may look like.

• Select one of your previously created groups, to which the reseller will be assigned.

• Then select one of your clients from the dropdown, start typing to see a list of clients

• Generate an API Key for the Reseller, it will be necessary when configuring the integration module with the Reseller's platform

• Prepare a list of allowed IP addresses, use comma or a space to separate - note that this option must have been enabled previously in the module general settings here

• API Status - toggle to allow reseller generate the API key in the Reseller area

• API Limits - toggle to be able to define precise limits
  • API Interval [Min] - enter a time interval in minutes in which a provided below number of API requests can be called
  • API Requests Limit - maximum number of API requests in the time interval

Apart from them, you may preview the API Email Address and API Key required to activate and configure the integration module.

In order to add a new response template press the 'Create Template' button and then follow the below instructions.

• For Text type, simply provide a string like 'Error Response'.
  
• For Regular Expression type, you need to provide a regular expression which will be replaced.
  For example, if you want to replace any dollar price in the response provide '\$\d+\.\d+', in this case it will replace strings like '$8.25'.
  
• If you want to replace any response, simply type '.+' in here.

• choose 'Text' or 'Regular Expression' from Type dropdown menu.
  

It will specify if provided text in the first field should be treated as a text or a regular expression while searching for a pattern.

• Registrar Action - must be chosen from dropdown menu as well to specify upon which action provided patterns will be searched for.

Remember, to finish successfully you need to press 'Confirm' button.

This API documentation has been prepared to allow you to write your own integration modules for platforms other than WHMCS and Blesta (included by default).

'Information' subtab contains:

• Endpoint - URL to which all the API requests are directed

• Authorization - Username and token parameters to authenticate the client in the API request

• Example - exemplary request to API to renew a domain

Note: The screen below does not capture all the supported functions.
Full API functionality can be found on the module features list at the top of this documentation.

Go to 'Domains' → 'Reseller Area' to access them.

This API documentation has been prepared to allow you to write your own integration modules for platforms other than WHMCS and Blesta (included by default).

'Information' tab contains:

• Endpoint - URL to which all the API requests are directed

• Authorization - Username and token parameters to authenticate the client in the API request

• Example - exemplary request to API to renew a domain

Note: The screen below does not capture all the supported functions.

Please refer to section Integrations to learn how to generate an integration module for your resellers.

Once you have extracted the module, you should find a new folder with the registrar in 'resellerWHMCS/modules/registrars/' directory.
Important: The folder and module name, logo and description of the extracted integration module is customized by the provider and will be different than the one presented in the example below.

You can find these data in your Reseller Area in the Provider's Client Area. Afterwards, press 'Save Changes'.

Set up TLD your provider allows you to resell, select additional features, choose registrar you have just installed from a dropdown menu and save it through pressing 'Save Changes'.

It will open in a new window, so make sure your browser does not block it.

You can find more information about the pricing in Domain Orders Extended For WHMCS here.

There, find 'Overwrite Registrar' option and toggle it. A dropdown menu with available registrars will appear. Select the integration module delivered by your provider.

• Lagom theme
• General Category View
• Multi Category View
• List View

They will simply have to add and set up each TLD separately at the 'System Settings' → 'Domain Pricing', which may be time consuming.
That is why we highly recommend using the modules together to manage the time optimally.

A win-win situation with benefits for all: you expanding and perfecting your offer, your resellers managing the TLDs and surely for the end-clients enjoying the final outcomes!

WHMCS Client Area view with an ordered domain via integration module.

In a basic workflow 3 users take part:
Provider – a person with Domains Reseller For WHMCS installed on the WHMCS system.
Reseller - a provider's client who aims at reselling TLDs offered to him by the provider.
The reseller must own a system with integration module generated for him by the provider with Domains Reseller For WHMCS.
End Client – a person with a client account in the Reseller's system (WHMCS, Blesta or others).

Provider's Part
Let us start from the beginning. Provider installs Domains Reseller For WHMCS in the system.
He already has some TLDs in the offer and wishes to allow the reseller to resell them.
Now, the provider configures Domains Reseller For WHMCS, creates groups, configures them and assigns TLDs and defines their pricing for the reseller who is assigned to one of the groups.
Finally, selects which of the clients will become resellers, assigns them to previously created groups and generates access details.

Reseller Part
The Reseller has access to the Reseller Area once logged into the provider's client area.
There, he can download both the integration module and its documentation as well as generate and copy any API details required to activate the integration module in his own system.
Then, the reseller needs to set up TLDs that the provider allows him to resell with the integration module delivered by the provider. Defines the pricing (prices must be higher than the ones the provider has set up to generate any income).
There is one step that separates the reseller from offering the domain from his system.
The reseller must add funds to his credit balance in the provider system to be able to pay off the charges and settle the amounts owed to the provider for his resold TLDs .
Provider creates an 'add funds invoice' for the Reseller, the Reseller pays the invoice and then again the Provider adds the same amount to Reseller's credit balance.
From now on, any domain can be ordered.

End Client
End Client orders a domain from his client area in the Reseller's system.

Last Word About Payment
Now, that the End-Client has ordered and paid the reseller for the domain, at the provider's system a new invoice for that domain is created automatically (on behalf of the reseller).
Depending on the selected "Payment Type" configuration the invoice will be paid with credits and domain attempted to be registered or attempt to register the domain and if successful, the invoice will be paid with credits.
In case the reseller does not have sufficient credits on his account to pay for the domain registration the process is stopped until the invoice is manually paid by the reseller.
The reseller's income is the difference between the price of the sold domain to the End-Client and the price he paid to the provider.

Follow the steps below to create and configure the Domains Reseller product:

1. In order to create a new Domains Reseller product, go to 'Setup' → 'Products/Services' → 'Products/Services'.
Press 'Create New Group' to add a new one.

Note that there is no server that shall be selected. Your product is ready to order!

• Create - once a client orders the product, go to Client's Products/Services and run the 'Create' action.
  When successful, the client appears on the list of resellers in your addon (see the screen below)

• Suspend - after successful Suspend action in the Client's Products/Services, the ' API Key Status ' of this reseller is switched off

• Unsuspend - run 'Unsuspend ' command to again switch on the reseller's 'API Key Status '

• Terminate - when the product is terminated, the Reseller's 'API Key Status' is again switched off

They will get access to 'Reseller Area', where from they can resell the domains, that belong to its pricing group, further.

You are able to easily prepare registrar module for any system (HostBill, Clientexec, BoxBilling and many more) using Domains Reseller For WHMCS API.
All you need is knowledge of for example PHP programming language and our module's API.

Please be aware that when updating from version 1.x. to 2.0.0 of the module no data are migrated!
All the resellers and their configuration will need to be set up from the beginning.

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.

• the reseller's WHMCS server
• the provider's server

Explanation: The Domains Reseller For WHMCS module does not support the "Transfer Ownership" action. If you attempt to transfer a domain between WHMCS clients (resellers), the above error will appear.
Solution: Transfer the domain between resellers manually at the database level. To do so, execute the following command:
UPDATE `DomainsReseller_ResellerRelations` SET `resellerid` = (SELECT id FROM `DomainsReseller_Resellers` WHERE `clientid` = :newClientID) WHERE relid = :domainId and type = 'domain';
Where:

• clientid - ID number of a WHMCS client (a reseller) to which a domain has been transferred
• relid - ID number of the transferred domain
  

based on the data from WHMCS system activity log.

For example:
UPDATE `DomainsReseller_ResellerRelations` SET `resellerid` = (SELECT id FROM `DomainsReseller_Resellers` WHERE `clientid` = 3804) WHERE relid = 5176 and type = 'domain';

Based on system activity log data:

Explanation: When the above error is returned by the API for any reseller domain action, it means that the order for this domain was added by default by WHMCS and not by the API of the module (reseller functionality).
Solution: The domain should be additionally imported to the reseller manually.