Domains Reseller For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
| Line 1: | Line 1: | ||
<meta name="keywords" content="domains reseller for whmcs, domains reseller configuration, whmcs domains reseller management, whmcs domains reseller installation, whmcs domains reseller common problems, about whmcs domains reseller, whmcs domains reseller documentation, whmcs domains reseller faq, whmcs domains reseller help, whmcs domains reseller guide, whmcs domains reseller wiki, whmcs domains reseller tutorial, whmcs domains reseller tips, whmcs domains reseller wiki"></meta> | <meta name="keywords" content="domains reseller for whmcs, domains reseller configuration, whmcs domains reseller management, whmcs domains reseller installation, whmcs domains reseller common problems, about whmcs domains reseller, whmcs domains reseller documentation, whmcs domains reseller faq, whmcs domains reseller help, whmcs domains reseller guide, whmcs domains reseller wiki, whmcs domains reseller tutorial, whmcs domains reseller tips, whmcs domains reseller wiki"></meta> | ||
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Domains Reseller For WHMCS Module."></meta> | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Domains Reseller For WHMCS Module."></meta> | ||
| − | |||
| − | |||
| − | |||
| − | |||
=About [https://www.modulesgarden.com/products/whmcs/domains-reseller Domains Reseller For WHMCS]= | =About [https://www.modulesgarden.com/products/whmcs/domains-reseller Domains Reseller For WHMCS]= | ||
| Line 13: | Line 9: | ||
|} | |} | ||
<!--a comment maybe? --> | <!--a comment maybe? --> | ||
| − | *'''Provider | + | *'''Provider:''' |
{| | {| | ||
| − | |style="padding: 10px 0px 0px 30px;"|✔ | + | |style="padding: 10px 0px 0px 30px;"|✔ View Resellers And TLDs Income Statistics |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ View Most Profitable Resellers And Lastest Invoices |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Create And Manage Resellers: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Assign To Dedicated Group |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Assign Client's Account |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Generate Access API Key |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Restrict Access To Specific IP Addresses |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Allow API Access |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Define API Limits Interval And Requests |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ View | + | |style="padding: 0px 0px 0px 45px;"|✔ View Reseller's Orders And Income |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Create And Manage Groups: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Allow API Access With Defined Permissions |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Allow Access To API Documentation |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Send Low Credit Notification |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ Define | + | |style="padding: 0px 0px 0px 45px;"|✔ Define Payment Collection Type: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ After Domain Registration |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ After Order Placement |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Define Refund Policy Upon Unsuccessful Domain Registration: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ Disabled |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ Via Credits Only |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ Via Invoice Refund |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Define Default Domain Registrant |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Define Tech/Admin/Billing Domain Contact Details |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Define Domain Contacts To Be Edited By End Clients |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 45px;"|✔ | + | |style="padding: 0px 0px 0px 45px;"|✔ Create Domain Registrar Integration Modules For Resellers: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ Choose Dedicated Platform: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 75px;"|✔ WHMCS |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 75px;"|✔ Blesta |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ Define Name And Description |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Provide Logo | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Attach Additional Fields Integration File | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ Attach Documentation | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Assign Offered TLDs For Resellers | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Define Pricing For Each TLD Extension: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ For Register, Transfer And Renew Action | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ For Each Year Period | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 60px;"|✔ For Each Currency | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Create Response Templates To Overwrite Registrars Messages Displayed To End Clients | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ Configure Default Settings: | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Global API Status | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Global API IP Restriction | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Global API Requests Restriction | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 45px;"|✔ Define Default Group Settings | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ View API Request And Response Logs | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 10px 30px;"|✔ View API Documentation | ||
|} | |} | ||
| − | *''' | + | *'''Resellers:''' |
{| | {| | ||
| − | |style="padding: 10px 0px 0px 30px;"|✔ | + | |style="padding: 10px 0px 0px 30px;"|✔ Access Dedicated Reseller Area |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ View Domains Orders |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ View TLDs Pricing |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Access Reseller Settings: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ View Available Account Credits |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Access API Details: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ View Available Credentials |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ View/Generate API Key |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 60px;"|✔ View/Modify IP Addresses Restrictions |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Download Domain Registrar Integration Module |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 45px;"|✔ Download Provider Documentation |
|} | |} | ||
| − | *'''End | + | {| |
| + | |style="padding: 0px 0px 0px 45px;"|✔ Download Additional Fields Integration File | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 0px 30px;"|✔ View API Request And Response Logs | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 10px 30px;"|✔ View API Documentation | ||
| + | |} | ||
| + | |||
| + | *'''End Clients:''' | ||
{| | {| | ||
|style="padding: 10px 0px 0px 30px;"|✔ Manage Contact Information | |style="padding: 10px 0px 0px 30px;"|✔ Manage Contact Information | ||
| Line 152: | Line 206: | ||
|style="padding: 0px 0px 10px 30px;"|✔ Enable/Disable ID Protection | |style="padding: 0px 0px 10px 30px;"|✔ Enable/Disable ID Protection | ||
|} | |} | ||
| − | *''' | + | |
| + | *'''API Functionality:''' | ||
{| | {| | ||
| − | |style="padding: 10px 0px 0px 30px;"|✔ | + | |style="padding: 10px 0px 0px 30px;"|✔ Register/Transfer/Renew Domain |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Release/Delete Domain |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Get/Modify Contact Details |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Get EPP Code |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Get/Modify Registrar Lock Status |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Get/Save DNS Records |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Get/Register/Modify/Delete Nameservers |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Get/Save Email Forwarding |
|} | |} | ||
| − | |||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 0px 30px;"|✔ Modify ID Protection |
| − | + | ||
|} | |} | ||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable ID Protection |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Check Domain And Transfer Synchronization |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Check Domain Availability |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Get Available TLDs |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Get Available Credits |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Get Version |
|} | |} | ||
| + | |||
| + | *'''General Info:''' | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 10px 0px 0px 30px;"|✔ Transactions Between Resellers And Provider Settled With Credits |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Domain Orders Extended For WHMCS</u> - Innovative Way Of Selling TLDs & gTLDS [https://www.modulesgarden.com/products/whmcs/domain-orders-extended (read more)] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.3 |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7.5 And Later |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/domains-reseller#open-source-version Open Source Version] |
| − | + | ||
|} | |} | ||
| + | |||
| + | =Installation= | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure Domains Reseller For WHMCS.''' <br /> |
| + | We will guide you step by step through the whole installation and configuration process. | ||
|} | |} | ||
| + | ==Module Installation - Provider== | ||
| + | <h5 style="color: #ff0000; font-weight:bold;">Please be aware that when updating from version 1.x. to 2.0.0 of the module no data are migrated!<br/> | ||
| + | All the resellers and their configuration will need to be set up from the beginning.</h5> | ||
| + | '' '''Note:''' If you are using Domains Reseller For WHMCS in any version '''prior to v2.x''', [https://www.docs.modulesgarden.com/Domains_Reseller_1_X_For_WHMCS follow these inbstructions].'' | ||
{| | {| | ||
| − | |style="padding: 0px | + | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.''' |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_1.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|''' | + | |style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/> |
| − | + | In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.<br/> If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. | |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP71_73.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/> |
| + | The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.<br/> | ||
| + | '''''Note:''' Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].'' | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_73.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 10px 15px;"|'' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/domains-reseller#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.''' |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''3. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory.'''<br /> |
| + | The content of the chosen PHP version files to upload should look like this. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:jioui.png]] |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''4. When you install Domains Reseller For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> |
| + | File is located in '' 'modules/addons/domainsReseller/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. '' | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR_3.png]] |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' file.' '' '''<br /> |
| + | 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'. '' | ||
|} | |} | ||
| − | |||
{| | {| | ||
| − | |style="padding: 0px 0px 20px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR_4.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br /> |
| + | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules'. '' Afterwards, find '' 'Domains Reseller' '' and press '' 'Activate' '' button. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_6.png]] |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br /> |
| + | To do so click on '' 'Configure' '' button, tick '' 'Full Administrator' '' and press '' 'Save Changes'. '' | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_7.png]] |
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Domains Reseller!'''<br /> |
| + | You can access your module at '' 'Addons' '' → '' 'Domains Reseller'. ''<br /> | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_8.png]] |
| − | + | ||
|} | |} | ||
==Module Installation - Reseller== | ==Module Installation - Reseller== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 20px 15px;"|'''Below you can find instructions for installation of the registrar module on reseller WHMCS.''' | + | |style="padding: 10px 0px 20px 15px;"|'''Below you can find instructions for installation of the registrar module on the reseller's WHMCS.'''<br/> |
| + | Please refer to section Submodule to learn how to generate a submodule for your resellers. | ||
|} | |} | ||
{| | {| | ||
| Line 317: | Line 362: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 25px;"|[[File: | + | |style="padding: 0px 0px 15px 25px;"|[[File:DR3_16.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|'''2. Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domains Registrar' '', find the module you have just uploaded and press '' 'Activate' '' next to it.''' |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_18.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''3. Now, press '' 'Configure' '' button, enter '' 'User Email' '' and '' 'API Key' '' provided along with the module.'''<br /> |
| − | + | You can find these data in your [[#Reseller Area|Reseller Area]] in the Provider's Client Area. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Afterwards, press '' 'Save Changes'. '' | Afterwards, press '' 'Save Changes'. '' | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_19.png]] |
|} | |} | ||
{| | {| | ||
| Line 347: | Line 383: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_20.png]] |
|} | |} | ||
{| | {| | ||
| Line 354: | Line 390: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_21.png]] |
|} | |} | ||
{| | {| | ||
| Line 360: | Line 396: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_22.png]] |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''8. Congratulations, you have just successfully installed your registrar!'''<br /> | |style="padding: 0px 0px 15px 15px;"|'''8. Congratulations, you have just successfully installed your registrar!'''<br /> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
| Line 375: | Line 406: | ||
|style="padding: 10px 0px 30px 15px;"|'''Domains Reseller For WHMCS allows your customers to resell domains on their own WHMCS.''' | |style="padding: 10px 0px 30px 15px;"|'''Domains Reseller For WHMCS allows your customers to resell domains on their own WHMCS.''' | ||
|} | |} | ||
| − | == | + | |
| + | ==Dashboard== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 20px 15px;"| | + | |style="padding: 10px 0px 20px 15px;"|Dashboard page includes some truly valuable graphs and summaries on income generated from reselling TLDs. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_24.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 15px;"|You may easily change the graph settings by changing the time scope and selecting TLDs you are interested in. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_25.png]] |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px | + | |style="padding: 0px 0px 20px 15px;"|Most profitable Resellers & Latest invoices summary |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_26.png]] |
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
| + | |||
| + | ==General Settings== | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 10px 0px 20px 15px;"|'' 'Settings' '' tab allows you to access general settings of your Domain Reseller API. <br/> |
| + | Here you may set up general options but still, you will be able to change them per single group. If you skip group settings, these configuration will be taken into account. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_28.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 10px 15px;"|We will describe these options below.<br /> | ||
| + | '''Global API''' related section:<br/> | ||
| + | *'' 'API Status'' ' - enable/disable Domains Reseller API.<br /> | ||
| + | *'' 'IP Addresses Restriction' '' - enable/disable restricting connection to Domains Reseller API only for IP addresses specified in the '' 'Allowed IP Addresses' '' field.<br /> | ||
| + | *'' 'API Requests Restriction' '' - enable option to restrict the number of API requests.<br /> | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_29.png]] | ||
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 10px 15px;"|'''Miscellaneous:'''<br /> | |style="padding: 0px 0px 10px 15px;"|'''Miscellaneous:'''<br /> | ||
*'' 'Low Credit Notification' '' - a notification to your client will be sent when credit balance on client's account falls below entered value.<br /> | *'' 'Low Credit Notification' '' - a notification to your client will be sent when credit balance on client's account falls below entered value.<br /> | ||
| + | *'' 'Low Credit Amount' '' - amount of credits, when reached a notification will be sent<br/> | ||
| + | |||
| + | *'' 'Payment Type' ''options: | ||
| + | **'' 'Pay After Registration' '' - resellers will be allowed to register domains without any credits. | ||
| + | **'' 'Pay After Order' '' - resellers will be able to pay for a domain after ordering it.<br /> | ||
| + | |||
| + | *'' 'Refund Type' '' - defines behavior of the module upon unsuccessful domain registration.<br /> | ||
| + | **'' 'Credits only' '' | ||
| + | **'' 'Refund Invoice' '' | ||
| + | **'' 'Disabled' '' | ||
| + | |||
*'' 'Default Registrant' '' - select default contact that will be used during registration. This option is available only if registrant contact uses WHMCS details.<br /> | *'' 'Default Registrant' '' - select default contact that will be used during registration. This option is available only if registrant contact uses WHMCS details.<br /> | ||
*'' '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.<br /> | *'' '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.<br /> | ||
| − | *'' ' | + | *'' '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.<br /> |
| − | + | Remember to submit the changes, once you have finished. | |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_30.png]] |
| − | + | ||
| − | + | ||
|} | |} | ||
| + | |||
| + | ==Groups== | ||
{| | {| | ||
| − | |style="padding: 0px | + | |style="padding: 10px 0px 15px 15px;"|At the '' 'API Users' '' tab you can manage all aspects related to your resellers who will be assigned to these groups later on.<br /> |
| + | Start by creating the first group for your resellers. Use either of the buttons marked on the screen below. | ||
|} | |} | ||
| − | |||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_30_1.png]] |
|} | |} | ||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 15px 15px;"|Then, simply type in a unique name of your group. <br/>Create as many groups as you will need and set up different configuration to adjust them and then assign resellers to adequate groups. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_31_1.png]] |
|} | |} | ||
| − | === | + | ===Configuration Per Group=== |
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 15px 15px;"|You can set up configuration for resellers who are assigned to this very group only.<br/> These settings will overwrite the general [[#General Settings|settings]] defined in the previous step. |
| − | + | *'' 'API Status' '' - enable/disable Domains Reseller API for Resellers assigned to this very group only<br /> | |
| + | *'' '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 option to restrict the number of API requests. | ||
| + | *'' 'Show API Documentation' '' - toggle to allow resellers access to API documentation directly from their reseller Area. | ||
| + | *'' 'Low Credit Notification' '' - turn on sending notifications to your client when credit balance on client's account falls below entered value. | ||
| + | *'' 'Low Credit Amount' '' - amount of credits, when reached a notification will be sent | ||
| + | *'' 'Payment Type' '' options: | ||
| + | **'' 'Pay After Registration' ''- resellers will be allowed to register domains without any credits. | ||
| + | **'' 'Pay After Order' ''- resellers will be able to pay for a domain after ordering it. | ||
| + | *'' 'Refund Type' '' - defines behavior of the module upon unsuccessful domain registration. | ||
| + | **'' 'Credits only' '' | ||
| + | **'' 'Refund Invoice' '' | ||
| + | **'' 'Disabled' '' | ||
| + | *'' '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. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_32.png]] |
|} | |} | ||
| − | === | + | ===API Permissions=== |
{| | {| | ||
| − | |style="padding: 10px 0px | + | |style="padding: 10px 0px 15px 15px;"|Toggle options that resellers will be allowed to use via API. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_34.png]] |
|} | |} | ||
| − | === | + | |
| + | ===Integrations=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px | + | |style="padding: 10px 0px 15px 15px;"|In this section you can create and manage integration modules which resellers will need to upload and activate to be able to resell domains you offer them.<br/> |
| + | Press '' 'Add Integration' '' to begin. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_35.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|To generate a new integration module you need to provide following data: |
| + | *Select the target platform for the submodule: WHMCS or Blesta | ||
| + | |||
| + | *Enter your module unique name | ||
| + | |||
| + | *Decide whether to allow downloading Additional Fields in the Reseller's Area | ||
| + | |||
| + | *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. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_36.png]] |
|} | |} | ||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 15px 15px;"|Newly created Integration will appear on the list. You may: |
| − | + | #edit its details (change logo, description etc.) at any time | |
| − | + | #Download Domain Additional Fields | |
| + | #Download documentation if any has been provided | ||
| + | #Download the integration package | ||
| + | #Delete the integration | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_37.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|In order to delete numerous integration at once, use the mass action button. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_37_1.png]] |
|} | |} | ||
| + | |||
| + | ===TLDs=== | ||
{| | {| | ||
| − | |style="padding: 0px | + | |style="padding: 10px 0px 15px 15px;"|Create a list of TLDs with their custom pricing details that resellers assigned to this group will be allowed to offer to their clients.<br/> |
| + | Press '' 'Assign TLD' '' button to begin. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_38.png]] |
|} | |} | ||
| − | + | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 15px 15px;"|Select TLDs from the available and press '' 'Confirm'. '' <br/> To learn more about available TLDs, please refer to the official documentation [https://help.whmcs.com/m/setup/l/848612-configure-the-extensions-tlds-you-wish-to-offer here]. |
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_39.png]] |
|} | |} | ||
| − | |||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 15px 15px;"|Assigned TLDs will appear on the list, you may also preview here the registrar name of the TLD extension and pricing details.<br/> Press the '' 'Pricing' '' icon to set up your custom prices per TLD for resellers assigned to this group.<br/> Please, be aware that pricing set up here will overwrite your standard pricing set up in your WHMCS. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_41.png]] |
|} | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"|In the '' Set Pricing '' tab, you can set the domain pricing for each of registration periods in each available currency per every active TLD.<br /> | ||
| − | + | 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. <br/>'' '''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'''. | |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_42.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|If you want to set up the same prices for all TLDs in this group, simply use the mass action button to do it almost with one click. <br/> In the same way you may uncasing numerous TLDs from the group. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_42_1.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Your | + | |style="padding: 0px 0px 15px 15px;"|Your group configuration is now ready. If you have more groups, repeat these steps for each of them.<br/> |
| − | + | Remember that you may always edit the single group name or delete if no longer needed. Just press adequate buttons to do so. | |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_42_2.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|Keep in mind that you may never delete a group if there are any resellers assigned to the group.<br/> Before deleting it, you must choose an alternative group to which the resellers will be reassigned. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_42_3.png]] |
|} | |} | ||
| + | |||
| + | ==Resellers== | ||
{| | {| | ||
| − | |style="padding: 0px | + | |style="padding: 10px 0px 15px 15px;"|In this section you will find a list of your active Resellers. Press '' 'Add Reseller' '' to make one of your clients a reseller. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_43.png]] |
|} | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 15px 15px;"| | ||
| + | *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 [[#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 | ||
| + | |} | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_44.png]] |
| − | + | ||
|} | |} | ||
| + | ===Reseller Details=== | ||
| + | ====API Configuration==== | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|Here you may easily alter the settings that you have defined when creating the reseller.<br/> |
| + | Apart from them, you may preview the '''API Email Address''' and '''API Key''' required to activate and configure the integration module. | ||
|} | |} | ||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_45.png]] |
| − | + | ||
|} | |} | ||
| + | |||
| + | ====Orders==== | ||
{| | {| | ||
| − | |style="padding: 0px | + | |style="padding: 10px 0px 15px 25px;"|This section includes a list of orders placed to purchase a domain with offered to this reseller TLDs. <br/> Take a look at any crucial details on the orders. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_45_1.png]] |
| − | + | ||
| − | + | ||
|} | |} | ||
| + | |||
| + | ====Income==== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 25px;"|'' 'Income' '' tab contains a current list of invoices that generate any income for the reseller.<br/> Press the invoice ID and you will be redirected to the invoice summary. | ||
| + | |} | ||
| + | |||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_45_2.png]] |
|} | |} | ||
| Line 569: | Line 669: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|In '' 'Response Templates' '' section you may add and edit new templates with text messages/information that are sent to clients instead of defined here system responses.<br/> | |style="padding: 10px 0px 15px 15px;"|In '' 'Response Templates' '' section you may add and edit new templates with text messages/information that are sent to clients instead of defined here system responses.<br/> | ||
| − | In order to add a new response template press '' | + | In order to add a new response template press '' 'Crate Template' '' button and then follow the below instructions. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_46.png]] |
|} | |} | ||
{| | {| | ||
| Line 581: | Line 681: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_47.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|In | + | |style="padding: 0px 0px 15px 15px;"|In the second step '''Replace With''' you need to enter a text message that will be sent to a client when the above entered pattern is found.<br/> The two messages will be replaced with one another. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_48.png]] |
|} | |} | ||
{| | {| | ||
| Line 593: | Line 693: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_49.png]] |
|} | |} | ||
{| | {| | ||
| Line 600: | Line 700: | ||
''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.'' | ''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.'' | *''' 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 '' ' | + | Remember, to finish successfully you need to press '' 'Confirm' '' button. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_50.png]] |
|} | |} | ||
{| | {| | ||
| Line 609: | Line 709: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_51.png]] |
| + | |} | ||
| + | |||
| + | ==Module Logs== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|In '' 'Logs' '' section you may preview a list of API requests and responses with the most important details on them. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_51_1.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|Use action buttons to delete all logs or just single entries. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_51_2.png]] | ||
|} | |} | ||
==Documentation== | ==Documentation== | ||
| + | |||
| + | ===API Documentation=== | ||
{| | {| | ||
| − | |style="padding: 10px 0px | + | |style="padding: 10px 0px 15px 15px;"|Under '' 'Documentation' '' tab you will find two subsection. The first one is dedicated to API.<br/> |
| + | '' '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 | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_53.png]] |
|} | |} | ||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 20px 15px;"|'' 'Calls' '' subtab contains information about actions supported by the API. |
| − | + | |} | |
| − | + | {| | |
| − | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_54.png]] | |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|The last section includes '' 'Models' '' details. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_55.png]] | ||
|} | |} | ||
| − | == | + | ===Module Documentation=== |
{| | {| | ||
| − | |style="padding: 10px 0px | + | |style="padding: 10px 0px 20px 15px;"|'' 'Module Documentation'' ' is a hyperlink. It leads to the '' 'Domains Reseller For WHMCS' '' wiki article you are currently reading. |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_52.png]] |
|} | |} | ||
| + | |||
| + | ==Reseller Area== | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 10px 0px 15px 15px;"|Resellers can manage API connection credentials directly from the provider WHMCS client area as well as see any details on its TLDs offer.<br /> |
| − | + | Go to '' 'Domains' '' → '' 'Reseller Area' '' to access them. | |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_56.png]] |
|} | |} | ||
| + | ===Orders=== | ||
{| | {| | ||
| − | |style="padding: 0px | + | |style="padding: 10px 0px 15px 15px;"|As you can see, '' 'Orders' '' section includes a detailed list of orders placed on domains with offered TLDs, with any payment details and date. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_57.png]] |
|} | |} | ||
| − | == | + | ===Pricing=== |
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 20px 15px;"|'' 'Pricing' '' section includes a list of the Reseller's TLDs with the option to preview its pricing set up by the provider. |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_58.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_59.png]] |
|} | |} | ||
| + | ===Settings=== | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 10px 0px 20px 15px;"|Under '' 'Settings' '' section you will find any API details necessary to install and activate the integration module. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_60.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|Underneath the API details you will find a list of generated integrations.<br/> Depending on the provider, you may download the packages, download the additional fields and documentation per Integration. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_61.png]] |
|} | |} | ||
| + | |||
| + | ===Logs=== | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 10px 0px 20px 15px;"|Preview a list of logs on API requests and responses stored in the module. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_62.png]] |
|} | |} | ||
| + | |||
| + | ===API Documentation=== | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 10px 0px 20px 15px;"|Access API documentation details with basic information and API Calls and Models.<br/> |
| + | '' '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 | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_63.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"| | + | |style="padding: 0px 0px 20px 25px;"|Available '' 'API Calls' '' list: |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_63_1.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|Available '' 'API Models' '' list: |
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:DR3_63_2.png]] | ||
| + | |} | ||
| + | |||
| + | ==End Client Area== | ||
| + | {| | ||
| + | |style="padding: 10px 0px 15px 15px;"|Domains Reseller integration module allows end clients to register, transfer and renew domain as well as run standard actions on domains.<br/> | ||
| + | WHMCS Client Area view with an ordered domain via integration module. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 25px;"|[[File:DR2_64.png]] | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 20px 15px;"|Blesta Client Area view with an ordered domain via integration module. | ||
| + | |} | ||
| + | {| | ||
| + | |style="padding: 0px 0px 30px 25px;"|[[File:DR2_64_1.png]] | ||
|} | |} | ||
| Line 697: | Line 854: | ||
{| | {| | ||
|style="padding: 10px 0px 30px 15px;"|In this section we will present to you a sample workflow of the module.<br /> | |style="padding: 10px 0px 30px 15px;"|In this section we will present to you a sample workflow of the module.<br /> | ||
| − | In a basic workflow 3 | + | |
| + | In a basic workflow 3 users take part:<br /> | ||
'''Provider''' – a person with Domains Reseller For WHMCS installed in their system.<br /> | '''Provider''' – a person with Domains Reseller For WHMCS installed in their system.<br /> | ||
'''Reseller''' - a person with a client account in the provider's WHMCS system.<br /> | '''Reseller''' - a person with a client account in the provider's WHMCS system.<br /> | ||
Additionally, the reseller has its own system with registrar generated by Domains Reseller For WHMCS.<br /> | Additionally, the reseller has its own system with registrar generated by Domains Reseller For WHMCS.<br /> | ||
| − | '''End | + | '''End Client''' – a person with a client account in the Reseller's system.<br /> |
<br /> | <br /> | ||
Additionally, there also must be a product, which in this case will be domain 'sample.com' .<br /> | Additionally, there also must be a product, which in this case will be domain 'sample.com' .<br /> | ||
<br /> | <br /> | ||
'''Provider Part'''<br /> | '''Provider Part'''<br /> | ||
| − | Let | + | Let us start from the beginning. Provider installs Domains Reseller For WHMCS in the system.<br /> |
He or she already has a few TLDs in the offer and wishes to allow the reseller to offer them from their systems.<br /> | He or she already has a few TLDs in the offer and wishes to allow the reseller to offer them from their systems.<br /> | ||
| − | Now, the provider configures Domains Reseller For WHMCS through | + | Now, the provider configures Domains Reseller For WHMCS through creating groups, configuring them and assigning TLDs.<br /> |
| − | + | Afterward, Reseller must be created and assigned to appropriate groups.<br /> | |
| − | + | <br /> | |
'''Reseller'''<br /> | '''Reseller'''<br /> | ||
From this moment, Reseller is able to access API details from the client account in the Reseller area.<br /> | From this moment, Reseller is able to access API details from the client account in the Reseller area.<br /> | ||
| − | Additionally, he or she receives an email | + | Additionally, he or she receives an email from the Provider with registrar module and instruction on how to install it .<br /> |
Reseller installs the registrar in the system according to the instruction received.<br /> | Reseller installs the registrar in the system according to the instruction received.<br /> | ||
| − | He or she also sets up .com TLD in the system and assigns the previously installed | + | He or she also sets up .com TLD in the system and assigns the previously installed integration module to it.<br /> |
Now, there is one step that separates them from offering the domain from their system.<br /> | Now, there is one step that separates them from offering the domain from their system.<br /> | ||
| − | Reseller top- | + | Reseller top-ups his credit balance in the provider system.<br /> |
Provider creates an invoice for the Reseller, the Reseller pays the invoice and then again the Provider manually adds the same amount to Reseller's credit balance.<br /> | Provider creates an invoice for the Reseller, the Reseller pays the invoice and then again the Provider manually adds the same amount to Reseller's credit balance.<br /> | ||
| − | + | From now on, any .com domain can be ordered.<br /> | |
| − | '''End | + | '''End Client'''<br /> |
| − | End | + | End Client orders 'sample.com' domain from his or her client area in the Reseller system.<br /> |
They are now able to fully manage the domain.<br /> | They are now able to fully manage the domain.<br /> | ||
<br /> | <br /> | ||
| Line 727: | Line 885: | ||
Payment goes to the Reseller while, during registration process, credits from Reseller balance are withdrawn.<br /> | Payment goes to the Reseller while, during registration process, credits from Reseller balance are withdrawn.<br /> | ||
It is worth mentioning that the amount a customer paid is defined by a Reseller.<br /> | It is worth mentioning that the amount a customer paid is defined by a Reseller.<br /> | ||
| − | Credits withdrawn are equal to a domain price | + | Credits withdrawn are equal to a domain price the Provider defines in the module per reseller. |
|} | |} | ||
| + | |||
==Extended TLDs Management - Integration With [https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS Domain Orders Extended For WHMCS]== | ==Extended TLDs Management - Integration With [https://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS Domain Orders Extended For WHMCS]== | ||
| − | + | ||
| − | + | ||
| − | + | ||
{| | {| | ||
| Line 768: | Line 925: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:DR3_54_5.png]] |
|} | |} | ||
{| | {| | ||
| Line 801: | Line 958: | ||
=Tips= | =Tips= | ||
{| | {| | ||
| − | |style="padding: 10px 0px | + | |style="padding: 10px 0px 20px 15px;"|1. If your reseller gets an error '' 'Unable to register domain, please contact administration (license problem).', '' that means your license is invalid or expired. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|2. Make sure that you are not blocking access to the '' 'api' '' catalog by your '' '.htaccess' '' file. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|3. Domains Reseller For WHMCS enables you to resell your domains not only to WHMCS and Blesta systems.<br /> |
| − | You are able to easily prepare registrar module for any system ( | + | You are able to easily prepare registrar module for any system (HostBill, Clientexec, BoxBilling and many more) using Domains Reseller For WHMCS API.<br /> |
| − | All you need is knowledge of for example PHP programming language and [[# | + | All you need is knowledge of for example PHP programming language and our module's [[#API Documentation|API]]. |
|} | |} | ||
Revision as of 12:49, 22 March 2019
Contents
|
About Domains Reseller For WHMCS
| Domains Reseller For WHMCS allows you to resell TLDs as well as manage obtained income and resellers. All these in a single pane of glass. 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. |
- Provider:
| ✔ View Resellers And TLDs Income Statistics |
| ✔ View Most Profitable Resellers And Lastest Invoices |
| ✔ Create And Manage Resellers: |
| ✔ Assign To Dedicated Group |
| ✔ Assign Client's Account |
| ✔ Generate Access API Key |
| ✔ Restrict Access To Specific IP Addresses |
| ✔ Allow API Access |
| ✔ Define API Limits Interval And Requests |
| ✔ View Reseller's Orders And Income |
| ✔ Create And Manage Groups: |
| ✔ Allow API Access With Defined Permissions |
| ✔ Allow Access To API Documentation |
| ✔ Send Low Credit Notification |
| ✔ Define Payment Collection Type: |
| ✔ After Domain Registration |
| ✔ After Order Placement |
| ✔ Define Refund Policy Upon Unsuccessful Domain Registration: |
| ✔ Disabled |
| ✔ Via Credits Only |
| ✔ Via Invoice Refund |
| ✔ Define Default Domain Registrant |
| ✔ Define Tech/Admin/Billing Domain Contact Details |
| ✔ Define Domain Contacts To Be Edited By End Clients |
| ✔ Create Domain Registrar Integration Modules For Resellers: |
| ✔ Choose Dedicated Platform: |
| ✔ WHMCS |
| ✔ Blesta |
| ✔ Define Name And Description |
| ✔ Provide Logo |
| ✔ Attach Additional Fields Integration File |
| ✔ Attach Documentation |
| ✔ Assign Offered TLDs For Resellers |
| ✔ Define Pricing For Each TLD Extension: |
| ✔ For Register, Transfer And Renew Action |
| ✔ For Each Year Period |
| ✔ For Each Currency |
| ✔ Create Response Templates To Overwrite Registrars Messages Displayed To End Clients |
| ✔ Configure Default Settings: |
| ✔ Toggle Global API Status |
| ✔ Toggle Global API IP Restriction |
| ✔ Toggle Global API Requests Restriction |
| ✔ Define Default Group Settings |
| ✔ View API Request And Response Logs |
| ✔ View API Documentation |
- Resellers:
| ✔ Access Dedicated Reseller Area |
| ✔ View Domains Orders |
| ✔ View TLDs Pricing |
| ✔ Access Reseller Settings: |
| ✔ View Available Account Credits |
| ✔ Access API Details: |
| ✔ View Available Credentials |
| ✔ View/Generate API Key |
| ✔ View/Modify IP Addresses Restrictions |
| ✔ Download Domain Registrar Integration Module |
| ✔ Download Provider Documentation |
| ✔ Download Additional Fields Integration File |
| ✔ View API Request And Response Logs |
| ✔ View API Documentation |
- End Clients:
| ✔ Manage Contact Information |
| ✔ Manage Email Forwarders |
| ✔ Manage DNS Records |
| ✔ Register/Manage Private Nameservers |
| ✔ Enable/Disable ID Protection |
- API Functionality:
| ✔ Register/Transfer/Renew Domain |
| ✔ Release/Delete Domain |
| ✔ Get/Modify Contact Details |
| ✔ Get EPP Code |
| ✔ Get/Modify Registrar Lock Status |
| ✔ Get/Save DNS Records |
| ✔ Get/Register/Modify/Delete Nameservers |
| ✔ Get/Save Email Forwarding |
| ✔ Modify ID Protection |
| ✔ Enable/Disable ID Protection |
| ✔ Check Domain And Transfer Synchronization |
| ✔ Check Domain Availability |
| ✔ Get Available TLDs |
| ✔ Get Available Credits |
| ✔ Get Version |
- General Info:
| ✔ Transactions Between Resellers And Provider Settled With Credits |
| ✔ Integrated With Domain Orders Extended For WHMCS - Innovative Way Of Selling TLDs & gTLDS (read more) |
| ✔ Multi-Language Support |
| ✔ Supports PHP 5.6 Up To PHP 7.3 |
| ✔ Supports WHMCS Template Six |
| ✔ Supports WHMCS V7.5 And Later |
| ✔ Easy Module Upgrade To Open Source Version |
Installation
| This tutorial will show you how to successfully install and configure Domains Reseller For WHMCS. We will guide you step by step through the whole installation and configuration process. |
Module Installation - Provider
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.
Note: If you are using Domains Reseller For WHMCS in any version prior to v2.x, follow these inbstructions.
| 1. Log in to our client area and download the module. |
|
| 2. In the downloaded file you might find one or two packages that support different PHP versions. In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later. |
|
| Previous updates of the module may contain two packages dedicated to various PHP versions. The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3. |
|
| Important: This situation does not affect the open source version of this module which can be applied to any PHP from version 5.6 and later. Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'. |
| 3. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory. The content of the chosen PHP version files to upload should look like this. |
|
| 4. When you install Domains Reseller For WHMCS for the first time you have to rename 'license_RENAME.php' file. File is located in 'modules/addons/domainsReseller/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'. |
|
| 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'. |
|
| 6. Now you have to activate the module in your WHMCS system. Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules'. Afterwards, find 'Domains Reseller' and press 'Activate' button. |
|
| 7. In the next step you need to permit access to this module. To do so click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes'. |
|
| 8. You have just successfully installed Domains Reseller! You can access your module at 'Addons' → 'Domains Reseller'. |
|
Module Installation - Reseller
| Below you can find instructions for installation of the registrar module on the reseller's WHMCS. Please refer to section Submodule to learn how to generate a submodule for your resellers. |
| 1. Upload and extract the registrar module into your WHMCS. |
|
| 2. Go to 'Setup' → 'Products/Services' → 'Domains Registrar' , find the module you have just uploaded and press 'Activate' next to it. |
|
| 3. Now, press 'Configure' button, enter 'User Email' and 'API Key' provided along with the module. You can find these data in your Reseller Area in the Provider's Client Area. Afterwards, press 'Save Changes'. |
|
| 5. To continue, go to 'Setup' → 'Products/Services' → 'Domains Pricing'. 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'. |
|
| 6. Afterwards, set pricing for your TLD. To do so, press 'Open Pricing' text. It will open in a new window, so make sure your browser does not block it. |
|
| 7. Next, enter prices for specific actions. Press 'Save Changes' to confirm. |
|
| 8. Congratulations, you have just successfully installed your registrar! |
Configuration and Management
| Domains Reseller For WHMCS allows your customers to resell domains on their own WHMCS. |
Dashboard
| Dashboard page includes some truly valuable graphs and summaries on income generated from reselling TLDs. |
|
| You may easily change the graph settings by changing the time scope and selecting TLDs you are interested in. |
|
| Most profitable Resellers & Latest invoices summary |
|
General Settings
| 'Settings' tab allows you to access general settings of your Domain Reseller API. Here you may set up general options but still, you will be able to change them per single group. If you skip group settings, these configuration will be taken into account. |
|
| We will describe these options below. Global API related section:
|
|
Miscellaneous:
Remember to submit the changes, once you have finished. |
|
Groups
| At the 'API Users' tab you can manage all aspects related to your resellers who will be assigned to these groups later on. Start by creating the first group for your resellers. Use either of the buttons marked on the screen below. |
|
| Then, simply type in a unique name of your group. Create as many groups as you will need and set up different configuration to adjust them and then assign resellers to adequate groups. |
|
Configuration Per Group
| You can set up configuration for resellers who are assigned to this very group only. These settings will overwrite the general settings defined in the previous step.
Save the changes when ready. |
|
API Permissions
| Toggle options that resellers will be allowed to use via API. |
|
Integrations
| In this section you can create and manage integration modules which resellers will need to upload and activate to be able to resell domains you offer them. Press 'Add Integration' to begin. |
|
To generate a new integration module you need to provide following data:
|
|
Newly created Integration will appear on the list. You may:
|
|
| In order to delete numerous integration at once, use the mass action button. |
|
TLDs
| Create a list of TLDs with their custom pricing details that resellers assigned to this group will be allowed to offer to their clients. Press 'Assign TLD' button to begin. |
|
| Select TLDs from the available and press 'Confirm'. To learn more about available TLDs, please refer to the official documentation here. |
|
| Assigned TLDs will appear on the list, you may also preview here the registrar name of the TLD extension and pricing details. Press the 'Pricing' icon to set up your custom prices per TLD for resellers assigned to this group. Please, be aware that pricing set up here will overwrite your standard pricing set up in your WHMCS. |
|
| In the Set Pricing tab, you can set the domain pricing for each of registration periods in each available currency per every active TLD. In addition, if you put:
|
|
| If you want to set up the same prices for all TLDs in this group, simply use the mass action button to do it almost with one click. In the same way you may uncasing numerous TLDs from the group. |
|
| 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 if no longer needed. Just press adequate buttons to do so. |
|
| Keep in mind that you may never delete a group if there are any resellers assigned to the group. Before deleting it, you must choose an alternative group to which the resellers will be reassigned. |
|
Resellers
| In this section you will find a list of your active Resellers. Press 'Add Reseller' to make one of your clients a reseller. |
|
|
|
Reseller Details
API Configuration
| Here you may easily alter the settings that you have defined when creating the reseller. Apart from them, you may preview the API Email Address and API Key required to activate and configure the integration module. |
|
Orders
| This section includes a list of orders placed to purchase a domain with offered to this reseller TLDs. Take a look at any crucial details on the orders. |
|
Income
| 'Income' tab contains a current list of invoices that generate any income for the reseller. Press the invoice ID and you will be redirected to the invoice summary. |
|
Response Templates
| In 'Response Templates' section you may add and edit new templates with text messages/information that are sent to clients instead of defined here system responses. In order to add a new response template press 'Crate Template' button and then follow the below instructions. |
|
Provide the pattern for search and replace in the system response depending on the type.
|
|
| In the second step Replace With you need to enter a text message that will be sent to a client when the above entered pattern is found. The two messages will be replaced with one another. |
|
| Define Priority. The higher number you enter, the higher priority will be assigned. Important! Only the first occurrence with the highest priority will be replaced. |
|
Finally,
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.
Remember, to finish successfully you need to press 'Confirm' button. |
|
| Now you can see a newly configured response is visible on the list. You may edit the added response or remove it any time you need. Just use action buttons marked on the screen. |
|
Module Logs
| In 'Logs' section you may preview a list of API requests and responses with the most important details on them. |
|
| Use action buttons to delete all logs or just single entries. |
|
Documentation
API Documentation
| Under 'Documentation' tab you will find two subsection. The first one is dedicated to API. 'Information' subtab contains:
|
|
| 'Calls' subtab contains information about actions supported by the API. |
|
| The last section includes 'Models' details. |
|
Module Documentation
| 'Module Documentation ' is a hyperlink. It leads to the 'Domains Reseller For WHMCS' wiki article you are currently reading. |
|
Reseller Area
| Resellers can manage API connection credentials directly from the provider WHMCS client area as well as see any details on its TLDs offer. Go to 'Domains' → 'Reseller Area' to access them. |
|
Orders
| As you can see, 'Orders' section includes a detailed list of orders placed on domains with offered TLDs, with any payment details and date. |
|
Pricing
| 'Pricing' section includes a list of the Reseller's TLDs with the option to preview its pricing set up by the provider. |
|
|
Settings
| Under 'Settings' section you will find any API details necessary to install and activate the integration module. |
|
| Underneath the API details you will find a list of generated integrations. Depending on the provider, you may download the packages, download the additional fields and documentation per Integration. |
|
Logs
| Preview a list of logs on API requests and responses stored in the module. |
|
API Documentation
| Access API documentation details with basic information and API Calls and Models. 'Information' tab contains:
|
|
| Available 'API Calls' list: |
|
| Available 'API Models' list: |
|
End Client Area
| Domains Reseller integration module allows end clients to register, transfer and renew domain as well as run standard actions on domains. WHMCS Client Area view with an ordered domain via integration module. |
|
| Blesta Client Area view with an ordered domain via integration module. |
|
Workflow
| In this section we will present to you a sample workflow of the module. In a basic workflow 3 users take part: |
Extended TLDs Management - Integration With Domain Orders Extended For WHMCS
| Domain Orders Extended For WHMCS allows quick and easy management of multiple TLDs and lets you offer these TLDs to your resellers at hand! In this part we are going to present how fluently these two modules may work together to let you gain the most from the integration. |
| Open your Domain Orders Extended For WHMCS addon module, move to 'Predefined TLD Sets' section and install one of the TLD groups of your wish. |
|
| Come back to the 'TLDs Configuration', find your group with newly assigned TLDs and define pricing for each of them. To make it faster, select all TLDs and use a mass action button. |
|
| It is time to set up the pricing. Save the changes once ready. You can find more information about the pricing in Domain Orders Extended For WHMCS here. |
|
| Select all TLDs the same way you did earlier and 'Edit TLDs Configuration'. There, find 'Overwrite Registrar' option and toggle it. A dropdown menu with available registrars will appear. Select the one used in Domains Reseller module. |
|
| It is time to go back to 'Domains Reseller' module. Move to the 'Configuration' section to enable the previously configured TLDs. Your TLDs are now ready to be offered by your resellers. |
|
| Your resellers, who also own Domain Orders Extended For WHMCS, can quickly update their offer by installing the very same gTLD category. The next steps are exactly the same as those you have just performed: setting up the pricing and assigning the TLDs to the Domains Reseller For WHMCS registrar module generated by you. |
|
Most importantly, the offer can be now extremely client-friendly due to a high range of selection of Domain Orders Extended domain registration forms including:
|
|
| There is surely a solution for resellers who do not own Domain Orders Extended module yet. They will simply have to add and set up each TLD separately at the 'Setup' → 'Products/Services' → 'Domain Pricing', which may be time consuming. |
|
| As you can see, integrating of Domains Resellers For WHMCS with Domain Orders Extended For WHMCS allows you to offer vast array of TLDs with ease. 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! |
Tips
| 1. If your reseller gets an error 'Unable to register domain, please contact administration (license problem).', that means your license is invalid or expired. |
| 2. Make sure that you are not blocking access to the 'api' catalog by your '.htaccess' file. |
| 3. Domains Reseller For WHMCS enables you to resell your domains not only to WHMCS and Blesta systems. You are able to easily prepare registrar module for any system (HostBill, Clientexec, BoxBilling and many more) using Domains Reseller For WHMCS API. |
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! |
Common Problems
| 1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |
| 2. Error 'Function Not Supported by Registrar Module' means that registrar on main WHMCS does not support the operation you were trying to do. |