Domains Reseller For WHMCS
(→Installation Of Integration Module) |
(→Extended TLDs Management - Integration With Domain Orders Extended For WHMCS) |
||
Line 897: | Line 897: | ||
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 the Provider defines in the module per reseller. | Credits withdrawn are equal to a domain price the Provider defines in the module per reseller. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
Revision as of 15:35, 22 March 2019
Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!
We are sorry for the inconvenience caused.
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. |
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. In the next step, set up the 'storage' folder as recursively writable. This folder is available at 'yourWHMCS/modules/addons/domains_reseller/'. |
7. 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. |
8. 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'. |
9. You have just successfully installed Domains Reseller! You can access your module at 'Addons' → 'Domains Reseller'. |
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: |
Domains Reselling Workflow
Installation Of Integration Module
Below you can find instructions for installation of the integration 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! |
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: |
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. |