Personal tools
Namespaces

Variants
Actions

Hosting Quota Notifications 1.X For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Tree View)
Line 1: Line 1:
−
<meta name="keywords" content="ip manager for whmcs, ip manager configuration, whmcs ip manager management, whmcs ip manager installation, whmcs ip manager common problems, about whmcs ip manager, whmcs ip manager documentation, whmcs ip manager faq, whmcs ip manager help, whmcs ip manager guide, whmcs ip manager wiki, whmcs ip manager tutorial, whmcs ip manager tips, whmcs ip manager 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 IP Manager 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 [http://www.modulesgarden.com/products/whmcs/ip_manager/features IP Manager For WHMCS]=
+
 
 +
=About [http://www.modulesgarden.com/products/whmcs/domains_reseller/features Domains Reseller For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 0px;"|'''IP Manager For WHMCS''' allows you to conveniently add and manage IP subnet, and automatically assign IP addresses to your servers, products, addons or configurable options.<br />
+
|style="padding: 10px 0px 5px 0px;"|'''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.<br />  
−
With our module you will be also able to assign an IP subnet to a specified client, integrate with 3rd party applications like cPanel, export IP subnets or view clear graphs.<br />
+
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.<br />
−
You will also be able to synchronize IP addresses used by products in your WHMCS system with the module's IP subnets.<br />
+
Just generate your own registrar module with just a couple of clicks, hand it over to your resellers and admire the sales they generate.
−
What is more, IP Manager For WHMCS will allow your customers to easily manage their IP addresses from the WHMCS client area.
+
 
|}
 
|}
 
<!--a comment maybe? -->
 
<!--a comment maybe? -->
−
*'''Admin Area Features:'''
+
*'''Provider Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Multiple Configurations For Multiple Scenarios Of IP Addresses Assignment
+
|style="padding: 10px 0px 0px 30px;"|✔ Your Own API For Domains Reselling
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create Multiple Relations In One Configuration For Products, Addons, Configurable Options & Servers
+
|style="padding: 0px 0px 0px 30px;"|✔ Domain Registrar Module Generator For WHMCS & HostBill
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add IP Pools:
+
|style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable API
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ CIDR Notation
+
|style="padding: 0px 0px 0px 30px;"|✔ API Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ IP Addresses Range (IPv4 Only)
+
|style="padding: 0px 0px 0px 30px;"|✔ Restrict IP Addresses
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ IP Addresses List (IPv4 Only)
+
|style="padding: 0px 0px 0px 30px;"|✔ Reseller White List
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add IPv6 Block In CIDR Notation
+
|style="padding: 0px 0px 0px 30px;"|✔ Restrict IP Address Per Client
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Export IP Pools To XML And CSV Format
+
|style="padding: 0px 0px 0px 30px;"|✔ Auto Disable API For New Users
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Import IP Pools From XML And CSV Files 
+
|style="padding: 0px 0px 0px 30px;"|✔ Auto Generate API Key For New Users
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Synchronize IP Addresses Used By Products In WHMCS With IP Manager
+
|style="padding: 0px 0px 0px 30px;"|✔ SSL Connection
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Exclude Selected IP Addresses From IP Pool During Its Creation
+
|style="padding: 0px 0px 0px 30px;"|✔ Low Credit Notification
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrate With 3rd Party Applications:
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose TLDs Enabled For API
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ cPanel
+
|style="padding: 0px 0px 0px 30px;"|✔ Allow Reselling And Activating Domains For Chosen Clients Without Credits
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ [http://www.modulesgarden.com/products/whmcs/cpanel_extended/features cPanel Extended]
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Type Of Refund Upon Unsuccessful Domain Registration
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Plesk
+
|style="padding: 0px 0px 0px 30px;"|✔ List Of Clients With Possibility To Generate/Remove/Enable/Disable The API Key
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Parallels Cloud Server
+
|style="padding: 0px 0px 0px 30px;"|✔ Generate/Enable/Disable API Keys For All Users
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ [http://www.modulesgarden.com/products/whmcs/solusvm_extended_vps/features SolusVM Extended VPS]
+
|style="padding: 0px 0px 0px 30px;"|✔ Filtering API Users Per Firstname, Lastname And E-mail
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ [http://www.modulesgarden.com/products/whmcs/proxmox_vps/features Proxmox VPS]
+
|style="padding: 0px 0px 0px 30px;"|✔ Assign Promocodes To Users
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create New Integration Modules
+
|style="padding: 0px 0px 0px 30px;"|✔ API Knowledgbase Generator
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign/Unassign IP Addresses From IP Pool For Specified Client Service
+
|style="padding: 0px 0px 10px 30px;"|✔ API Logs With Filtering
 
|}
 
|}
 +
*'''API Functionality:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Omit Dedicated IP Address Fields For Specific Configuration
+
|style="padding: 10px 0px 0px 30px;"|✔ Register/Transfer/Renew Domain
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Custom Field Usage
+
|style="padding: 0px 0px 0px 30px;"|✔ Release/Delete Domain
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Receive Automatic Email Reminder Sent When Specified Usage Percentage Of Any IP Pool Has Been Exceeded
+
|style="padding: 0px 0px 0px 30px;"|✔ Modify Contact Details
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Configuration Of Integration Method (cPanel & cPanel Extended)
+
|style="padding: 0px 0px 0px 30px;"|✔ Get EPP Code
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Set Up IP Addresses Cleaner - Ensures That All Assigned IP Addresses Are In Use
+
|style="padding: 0px 0px 0px 30px;"|✔ Get/Save DNS Records
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View IP Pool Usage Statistics And Graphs
+
|style="padding: 0px 0px 0px 30px;"|✔ Get/Modify Nameservers
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
+
|style="padding: 0px 0px 0px 30px;"|✔ Register/Modify/Delete Nameserver
 
|}
 
|}
−
*'''IP Pool Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Lock IP Pool To Client
+
|style="padding: 0px 0px 0px 30px;"|✔ Registrar Lock
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Filter Data In IP Addresses List
+
|style="padding: 0px 0px 0px 30px;"|✔ Get/Save Email Forwarding
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View IP Addresses Of IP Pool
+
|style="padding: 0px 0px 0px 30px;"|✔ ID Protection
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Delete Single IP Address From Pool
+
|style="padding: 0px 0px 10px 30px;"|✔ Domain Cron Synchronization
 
|}
 
|}
 +
*'''End User Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Bulk Actions - Assign/Unassign/Delete IP Addresses
+
|style="padding: 10px 0px 0px 30px;"|✔ View Contact Information
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Create Custom Fields For IP Pool Or IP Address
+
|style="padding: 0px 0px 0px 30px;"|✔ Manage Email Forwarders
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Generate Free IP Addresses
+
|style="padding: 0px 0px 0px 30px;"|✔ Manage DNS Records
 
|}
 
|}
−
*'''IP Block Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ View IP Pools Of Block
+
|style="padding: 0px 0px 0px 30px;"|✔ Register/Manage Private Nameservers
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View IP Addresses Of IP Pool
+
|style="padding: 0px 0px 10px 30px;"|✔ Enable/Disable ID Protection
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Assign/Unassign/Delete Any IP Pool
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Create Custom Fields For IP Pools
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Generate Free IP Pools
+
−
|}
+
−
*'''Client Area Features:'''
+
−
{|
+
−
|style="padding: 10px 0px 0px 30px;"|✔ View Assigned IP Addresses
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Unassign IP Addresses
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 30px;"|✔ Order Additional IP Addresses
+
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports IPv4 and IPv6
+
|style="padding: 10px 0px 0px 30px;"|✔ Orders Paid By Resellers' Credit
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Supported All Types Of Configurable Options
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ IPv6 Pools Relying On IP Addresses Range And Assigned IP Addresses (Free IPv6 Addresses Are Not Stored In Database)
+
|style="padding: 0px 0px 0px 30px;"|✔ Reseller Can Manage API From The WHMCS Client Area
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Block Assignment Of IP Addresses For IPv6
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Domain Orders Extended For WHMCS</u> - Innovative Way Of Selling TLDs & gTLDS [http://www.modulesgarden.com/products/whmcs/domain_orders_extended/features (read more)]
 
|}
 
|}
 
{|
 
{|
Line 165: Line 143:
 
=Installation=
 
=Installation=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''This tutorial will show you how to successfully install and configure IP Manager For WHMCS.''' <br />
+
|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.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 +
==Module Installation - Provider==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''1. Log in to your client area and download IP Manager For WHMCS.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Domains Reseller For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_1.png]]
 
|}
 
|}
 
{|
 
{|
Line 179: Line 158:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. When you install IP Manager for the first time, you have to rename '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Domains Reseller for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
File is located in '' 'modules/addons/IPM2_anager2/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
File is located in '' 'modules/addons/domainsReseller/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. 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 your client area'' → 'My Products'. ''
+
Enter your license key between quotation marks as presented on the following screen. You can find your license key at your client area'' → 'My Products' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_4.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''5. Remove all files from '' 'tempates_c' '' folder located in your WHMCS root directory.'''
+
|style="padding: 0px 0px 15px 15px;"|'''5. Edit '' 'header.tpl' '' file located at '' 'your_whmcs/templates/default/header.tpl' ''.<br />
 +
''Important! This edition is required only if you use WHMCS V5x.x. <br/>There are no alterations in templates for WHMCS V6x.x.''<br/>
 +
Add this code:
 +
<nowiki>{if $dr_show_button}<li><a href="index.php?m=domainsReseller">Reseller Registrar Credentials</a></li>{/if}</nowiki>
 +
After:
 +
<nowiki><li><a id="Menu-Domains-Whois_Lookup" href="domainchecker.php">{$LANG.navwhoislookup}</a></li></nowiki>
 +
Take a look at the screenshot below and verify your changes:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now, you have to activate the module in your WHMCS system.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_5.png]]
−
Log in to your WHMCS admin area and go to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
+
−
Afterwards, find '' 'IP Manager' '' and press '' 'Activate' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_5.png]]
+
|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 15px 15px;"|'''7. In the next step you need to permit the access to the module.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_6.png]]
−
Click on '' 'Configure' '' button, tick desired admin roles and press '' 'Save Changes'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_6.png]]
+
|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 15px 15px;"|'''8. The last step is setting chmod 755 to '' 'storage' '' folder.'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_7.png]]
−
Folder is located in '' 'you_whmcs/modules/addons/IPM2_anager2'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM6.1.png]]
+
|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 />
 +
Now it's time to set up registrar module, it will be used by your resellers registrar to manage domains.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. You have just successfully installed IP Manager!'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_8.png]]
−
You can access your module in '' 'Addons' '' → '' 'IP Manager'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_7.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''9. Activate and configure registrar at '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domains Registrar' ''.'''
−
|}
+
−
 
+
−
=Configuration and Management=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|'''IP Manager For WHMCS allows you to manage dedicated IP addresses' pools, automatically assign them to clients/products/servers/addons/configurable options.<br />
+
−
IP Manager supports both IPv4 and IPv6. '''<br />
+
−
Module enables clients to manage and order dedicated IP addresses.<br />
+
−
In this short guide we will present you the possibilities of our module.
+
−
|}
+
−
==Subnets==
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|To manage any Subnet via IP Manager you have to add it first.<br />
+
−
Remember that it is very important to configure any IP reservation rules before you create any subnets. If you add rules later on, they may not work properly!<br/>
+
−
Read about rules reservation [LINK DO RUKLI here.]
+
−
 
+
−
To add a new subnet press '' 'Create New Subnet' '' and follow further instructions.
+
−
|}
+
−
===Create Subnet===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|To begin, add a new IP addresses subnet, press'' 'Create New Subnet' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'' 'Classless Inter-Domain Routing (CIDR)' '' can be used to add subnets.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''10. Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domains Pricing' ''.'''<br />
−
First of all, select IP version: IPv4 or IPv6, type the subnet IP address and a correct bitmask.<br/>
+
Add TLD, set pricing for it and choose automatic registrar you have just configured.
−
Correct ranges:<br/>
+
−
*IPv4 - 1 to 32
+
−
*IPv6 - 1 to 128
+
−
''Note: The first IP from the subnet should be compatible with [http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing CIDR notation].''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_10.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can exclude any number of IP addresses from the pool.<br />
+
|style="padding: 0px 0px 15px 15px;"|'''11. To generate registrar for your resellers, make sure that '' 'module_generator' '' folder has chmod set to '755' or '777'.'''<br />
−
To do so, enter them into '' 'Excluded IP Addresses:' '' textarea, one IP address or IP range per line.<br />
+
Folder is located in '' 'your_whmcs/modules/addons/domainsReseller/pages/ ' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If you want to set nameservers and gateway click on '' 'Toggle Advanced Settings'. ''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''12. Go to Domains Reseller addon and switch to '' 'Configuration' '' tab.'''<br />
−
Enter nameservers and gateway address into textboxes as shown on the screen below ''(This step is optional)''.<br />
+
Mark checkbox next to TLD you want to resell and press '' 'Save Changes' '' button.
−
Afterwards, confirm the creation of an IP pool through pressing '' 'Add Subnet' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_12.png]]
 
|}
 
|}
  
−
===Available IP Subnets and Child-Subnets===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Once you have added some IP pools you can preview some details on them and manage the IP addresses.
+
|style="padding: 0px 0px 20px 15px;"|'''13. In '' 'Module Generator' '' tab enter module name into textbox and press '' 'Generate Module' '' button.'''
−
As you can see on the following screen, you can find here a list of Subnets in a tree view. Press any of added IP subnets to see its details.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_13.png]]
 
|}
 
|}
−
====Subnet====
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|To view subnet's details press on its address as shown on the following screen.
+
|style="padding: 0px 0px 15px 15px;"|'''14. Downloading of the module you have just generated will start shortly.'''<br />
 +
You can provide registrar module for your resellers in two ways, by sending them a file or a link to it.<br />
 +
The link should appear right after the module has been generated.<br />
 +
'''Important:''' Save the link and the installation instruction marked on the screen below, it will not appear again.<br />
 +
''Note: You have to provide integration code (step 5. of installation instructions) to your resellers.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_14.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In '' 'Subnet'' ' field, you can find information about the address, mask, size, nameservers, gateway and many others.
+
|style="padding: 0px 0px 15px 15px;"|'''15. Now you have to generate API key for your client. Go to '' 'API Users' '' tab.<br />
 +
Afterwards, press '' 'Generate API Key' '' next to the user you want to generate API key for.<br />
 +
Note that API key and the user's email are needed as credentials at the registrar module you have just generated.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_15.png]]
 
|}
 
|}
−
'''Bulk Actions'''
 
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|The most important functions of your IP Manager For WHMCS include some actions that can done on subnets.<br />
+
|style="padding: 0px 0px 30px 15px;"|'''Your Domains Reseller module is ready to use!'''<br />
−
|}
+
Your clients can use their registrars as soon as they install them on their WHMCS and '''add credits''' to their accounts in your WHMCS.
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|
+
−
*'''Delete''' - use it to remove the subnet together with any IP address in it (if there are such already).
+
−
*'''Split''' - select split to divide the subnet into equal subnets according to the chosen mask. Keep in mind that the subnet may already include some assigned IP addresses.<br/> If you split such a subnet, the assigned IPs might be transferred to another subnet.
+
−
*'''Merge''' - use this option if you want to join previously split subnet. Note that you can merge only parallel subnets.<br/>
+
−
Additionally, you must remember that merge action removes IP addresses from external servers.
+
−
*'''Create Child Subnet''' - this option allows to create subnet within a  '' 'parent' '' subnet.
+
−
*:Such child subnet may again be slit/merged, have its own child subnets.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_17.png]]
+
 
|}
 
|}
  
−
====Excluded IP Addresses====
+
==Module Installation - Reseller==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|List of excluded IP addresses. You can remove some addresses from the list or add new ones. <br/>
+
|style="padding: 10px 0px 20px 15px;"|'''Below you can find instructions for installation of the registrar module on reseller WHMCS.'''
−
Important! If you have any IP reservation rules set up, then do not include singe IP addresses here. This option should be used as an addition if you do not use rules.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_18.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''1. Upload and extract the registrar module into your WHMCS.'''
 
|}
 
|}
−
====Custom Fields====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|IP Manager allows you to add custom fields per subnet.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_16.png]]
−
To add a new custom field, press '' 'Create New Custom Field'. '' Afterwards, fill out the form with custom field name and value. <br/>
+
−
Again, this option should be used if you do not specify default custom fields or if you want to add some additional ones. Be careful and do not double custom fields here.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_19.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''2. Enter integration code that you got from your provider.<br />
 +
Open '' 'additionaldomainfields.php' '' file located at '' 'includes/additionaldomainfields.php' ''.<br />
 +
Paste the code you received at the end of the file.
 
|}
 
|}
−
 
−
====Assigned Client/Service====
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|If you wish to assign an IP pool to a client or specific service, our module makes it available to you.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_17.png]]
−
You can achieve that through using auto-complete textbox to choose the client and/or service.
+
−
Again, remember to '' 'Save Changes'. ''<br />
+
−
''Notes:<br/>
+
−
IP addresses will be added to all products ordered by client.<br/>
+
−
IP addresses will be added to all addons included in products.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_20.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''3. Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domains Registrar' '', find the module you have just uploaded and press '' 'Activate' '' next to it.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Keep in mind that a subnet that is assigned to a client is reserved for this client only.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_18.png]]
−
While IP addresses are assigned to a client, the following aspect s are taken into consideration (in this order):
+
−
*subnets assigned to a hosting
+
−
*subnets assigned to a client
+
−
*subnets assigned to configuration.
+
 
|}
 
|}
−
 
−
===IP Addresses List===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The easiest possible way of creating IP addresses within the created subnet.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''4. Now, press '' 'Configure' '' button, enter '' 'User Email' '' and '' 'API Key' '' provided along with module.'''<br />
−
Simply press '' 'Create IP Address' '' and a new address in the subnet will be generated.  
+
Afterwards, press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_21.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_19.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Once the address is generated, you can proceed to its assignment.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''5. To continue, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domains Pricing' ''.'''<br />
−
Use action buttons to do do so.
+
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' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_20.png]]
 
|}
 
|}
−
====Assign Single IP Address====
 
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|You are now redirected to a page where you can assign this specific IP address to a service by entering a domain or a username,<br/> using 3rd party integration module or custom assignment.
+
|style="padding: 0px 0px 15px 15px;"|'''6. Afterwards, set pricing for your TLD. To do so, press '' 'Open Pricing' '' text.'''<br />
 +
It will open in a new window, so make sure your browser will not block it.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Choose the method you wish to use and save the changes.
+
|style="padding: 0px 0px 20px 15px;"|'''7. Next, enter prices for specific actions. Press '' 'Save Changes' '' to confirm.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_24.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_22.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|As you can see, IP address is assigned to selected previously service (related to chosen domain).<br> You may always unassign this IP from this service and again assign it to another one, delete the IP address, create custom field for this single address.
+
|style="padding: 0px 0px 15px 15px;"|'''8. Congratulations, you have just successfully installed your registrar!'''<br />
 +
You can start using registrar as soon as you add credits to your account on provider WHMCS.<br />
 +
If you order a domain using this registrar, you should see in your admin area something similar to the screen below.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_25.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_23.png]]
 
|}
 
|}
  
−
===Tree View===
+
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To clarify, a comfortable tree view of your created subnets and child-subnets is available. Let's take a look at it to summarize the divisions.
+
|style="padding: 10px 0px 30px 15px;"|'''Domains Reseller For WHMCS allows your customers to resell domains on their own WHMCS.'''
 
|}
 
|}
 +
==Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_26.png]]
+
|style="padding: 10px 0px 20px 15px;"|'' 'Configuration' '' tab allows you to access general settings of your Domain Reseller API.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"| You can see here a list of all subnets and child subnets in your IP Manager. Subnets marked with red already have some child subnets created, press any to show the list of child subnets.<br/> Accordingly available actions change.  
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_24.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_27.png]]
+
|style="padding: 0px 0px 15px 15px;"|We will describe these options below.<br />
 +
1. '' 'API Status'' ' - Enable/Disable Domains Reseller API.<br />
 +
2. '' 'Restricted By IP Addresses' '' - Enable/Disable restricting connection to Domains Reseller API only for IP addresses specified in the '' 'Allowed IP Addresses' '' field.<br />
 +
3. '' 'Allowed IP Addresses' '' - The list of IP addresses allowed to connect with Domains Reseller when '' 'Restrict IP Address' '' option is enabled.<br />
 +
''Note: This option shows up only when  '''' 'Restrict IP Address' '' is enabled.<br />
 +
4. '' 'Pay After Registration' '' - The list of resellers who are able to pay for a domain after its registration.<br />
 +
5. '' 'Pay After Order' '' - The list of resellers who are able to pay for a domain after ordering it.<br />
 +
6. '' 'Auto Disable API For New Users' '' - API will be disabled for newly created clients.<br />
 +
7. '' 'Auto Generate API Key For New Users' '' - API Key will be generated automatically when client's account is created.<br />
 +
8. '' 'SSL Connection' '' - You can define here, if connection with your API will use SSL or not. When you change it, you will need to generate a new registrars for your resellers.<br />
 +
9. '' 'Refund' '' - Defines behaviour of the module upon unsuccessful domain registration.<br />
 +
10. '' 'Low Credit Notification' '' - Notification to your client will be sent when credit balance on client's account falls below entered value.<br />
 +
''Note 1: All changes should be saved, you can do it through pressing 'Save Changes' button.''<br />
 +
''Note 2: To sent an email notification about low credit balance, create a template 'Low Credit Notification' of 'General' type.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"| Any subnet can have child subnets created (with IP reservation rules taken into consideration) and custom fields assigned.
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_25.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_28.png]]
+
|style="padding: 0px 0px 15px 15px;"|To restrict access to the Domains Reseller API by IP address, simply choose '' 'Enable' '' from '' 'Restrict IP Addresses' '' dropdown menu.<br />
 +
New text field should appear, enter IP addresses you want to whitelist, one IP address per line.<br />
 +
At the end, press '' 'Save Changes' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"| Child subnets, however, can again have their child subnets created, can be split, merged or deleted. 
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_26.png]]
−
You may also manually exclude some IP addresses from a child subnet, assign clients and services directly to it and finally manage single IP addresses in such subnet.
+
 
|}
 
|}
−
 
−
==Settings==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''Along with great power comes great responsibility.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|Last, but not least important thing you can do here is enabling TLD for resell.<br />
−
IP Manager For WHMCS allows you to define its behavior, therefore make sure you configure settings that suit you needs.
+
It can be done simply by ticking TLD and pressing '' 'Save Changes' ''.
 
|}
 
|}
−
===Show Settings===
 
−
====Module Settings====
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Below, you can find description of each option.
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_27.png]]
−
*'''Assignment Process Settings'''
+
−
*#For any configuration you provide into this field, '' 'Dedicated IP' '' field will be omitted.
+
−
*#If checked, additional IP addresses will be stored in a custom field or '' 'Assigned IPs' '' field.
+
−
*#If checked, in case of a server provisioning failure, relation will be saved.
+
−
*#Automatically process the IP address when downgrading the configurable option.
+
−
*#Module ignores error message from an external server and continues the action.
+
−
*'''IP Logs Settings'''
+
−
*#IP addresses without product or user will not be displayed in '' 'IP Logs' '' page.
+
−
*'''IP Reservation Settings'''
+
−
*#If you check this checkbox, you will allow to add IP reservation rules.
+
−
*'''Email Reminder Settings'''
+
−
*#If you check this checkbox, you will receive an email with notification about IP subnets running out of IP addresses.
+
−
*#Enables you to define percentage value which, when exceeded by any subnet, results in a notification being sent.
+
 
|}
 
|}
 +
==API==
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_31.png]]
+
|style="padding: 10px 0px 30px 15px;"|At the '' 'API' '' tab you can find a lot of information about Domains Reseller API, as well as generate and share API knowledgebase.
 
|}
 
|}
−
 
+
===Introduction===
−
====IP Addresses Cleaner====
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|IP Addresses Cleaner allows you to restore/remove IP addresses form WHMCS/IP Manager/both depending on chosen settings.
+
|style="padding: 10px 0px 20px 15px;"|'' 'Introduction' '' subtab contains information about actions supported by the API.
−
*'''IP Addresses Cleaner Settings'''
+
−
*#IP address are added to hosting if relation exists.
+
−
*#IP address' relation are removed if IP address is not assigned to any hosting.
+
−
*#If IP address does not exist in any subnet, it is removed from hosting.
+
−
*#Create IP address' relation if it does not exist.
+
−
*#If IP address does not exist in any subnet, it is removed from relations.
+
−
*#Set IP address as unassigned if its relation does not exist.
+
−
'''Important:''' After making any changes in those settings, press '' 'Update Settings'. ''<br />
+
−
Otherwise, settings will not be saved and the Cleaner will run using old ones.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_32.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_28.png]]
 
|}
 
|}
 +
===Connection===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|IP Addresses Cleaner allows you to automatically find and fix broken IP addresses assignment.<br />
+
|style="padding: 10px 0px 15px 15px;"|In this subtab you can read about request and response data format as well as authentication.<br />
−
For example, when you manually remove a product with IP addresses assigned or remove an IP pool.<br />
+
You can also find URL to the API here.
−
To start IP Addresses Cleaner, press '' 'Perform Cron Cleanup' ''.<br />
+
−
Actions issued by the cleaner are listed in a popup as shown on the following screen.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM24_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_29.png]]
 
|}
 
|}
  
−
===IP Reservation===
+
===Examples===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|You can automate the process of IP assignment by adding some rules that will be then executed while assigning IP addresses from a subnet to clients or services.<br/>
+
|style="padding: 10px 0px 20px 15px;"|Here you can find sample API request and response.
−
'' 'IP Reservation' '' rules can be configured under '' 'Settings' '' section.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_34.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_30.png]]
 
|}
 
|}
 +
===Knowledgebase===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Use the rules consciously because they will be then taken into consideration while assigning any IP from any subnet in your IP Manager.<br/>
+
|style="padding: 10px 0px 20px 15px;"|'' 'Knowledgebase' '' subtab allows you to generate API knowledgebase for your resellers in your WHMCS client area and locate link to it (if already generated).
−
Like it is stated in the guide visible on the screen you must stick to some standards while personalizing your assignment process.<br/>
+
−
Press '' 'Add New Rule'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_35.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_31.png]]
 
|}
 
|}
−
====New Rules====
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|To add a new rule, type in the required value in the '' 'Rule' '' field and describe it in the text box nearby.<br/>
+
|style="padding: 0px 0px 20px 15px;"|When your clients follow a link to the knowledgebase they should see something similar to the screen below.
−
To illustrate:<br/>
+
−
Enter '''n''' in the '' 'Rule' '' textarea. Then the first IP address from a subnet will be always excluded. It will be reserved and it will not be assigned to any client or service.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_36.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_32.png]]
 
|}
 
|}
 +
==API Users==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can add more that one rule. If you do it thoughtfully, you will have much less work later on while creating new subnets because <br/>customized rules will substitute the need to fill out the '' 'Excluded IP Addresses' '' area.
+
|style="padding: 10px 0px 15px 15px;"|At the '' 'API Users' '' tab you can manage all aspects related to your resellers.<br />
 +
For your convenience we also implemented filters, you can use them to find a specific user or a group of users.<br />
 +
''Note: Remember to set default payment method for every reseller. It can be set up at client profile in 'Payment Method' dropdown menu.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_37.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_33.png]]
 
|}
 
|}
−
 
−
===Default Custom Fields===
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In this section ''('Settings' → 'Default Custom Fields')'' you are allowed to add and configure some custom fields that will be assigned to subnets by default.
+
|style="padding: 0px 0px 20px 15px;"|You can set up IP restriction per client (1), assign a promotion code to a single user (2), generate a new key for them(3) or disable API for them (4).
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_42.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_34.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|All you need to do is enter the name of your custom field, its value and save changes.
+
|style="padding: 0px 0px 20px 15px;"|Our module also allows performing these actions for all clients at once.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_43.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_35.png]]
 
|}
 
|}
 +
===IP Restriction===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Surely, you can create plenty of such custom fields and remove any if you no longer wish to use them.
+
|style="padding: 10px 0px 15px 15px;"|Let's ensure, that specific clients are able to connect with Domains Reseller API only from defined IP addresses.<br />
 +
Press '' 'IP Restriction' '', fill in IP address and press '' 'Save' ''.<br />
 +
''Note: To add multiple IP addresses, press '' 'Add Field' ''.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_44.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_36.png]]
 
|}
 
|}
  
−
==IP Assignment Mechanism==
+
===Assigning Promotion Codes===
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|It is crucial to understand mechanism of automatic IP addresses assignment. In this section we will clarify it to you.<br />
+
|style="padding: 10px 0px 15px 15px;"|You can create and assign promotion codes to your users.<br />
−
'' 'IP Quantity' '' field defines the quantity of IP addresses added to the ordered product by triggering a specific relation.<br />
+
Firstly, go to '' 'Setup' '' → '' 'Payments' '' → '' 'Promotions' '' and press '' 'Create New Promotion' ''.
−
Two and more relations from one configuration can be triggered for the same product (therefore, multiple quantity of IP addresses can be assigned).<br />
+
−
Additionally, if you set up two configurations with the same relation, IP addresses from both configurations will be added.<br />
+
−
Therefore, if you set up these two configurations in IP Manager:
+
−
*'''Configuration 1''':  Addon A (IP Quantity = 2), Product C (IP Quantity = 1)
+
−
*'''Configuration 2''':  Addon A (IP Quantity = 2), Addon B (IP Quantity = 2), Product D (IP Quantity = 3)
+
−
Orders listed below will trigger different relations:
+
−
*'''Order 1''': Product C with addon A: 5 IP addresses assigned
+
−
*'''Order 2''': Product C with addon B: 3 IP addresses assigned
+
−
*'''Order 3''': Product D with addon A: 7 IP addresses assigned
+
−
*'''Order 4''': Product F with addon A: 4 IP addresses assigned
+
 
|}
 
|}
−
===Automatic IP Assignment===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|The main reason, why this module has been created, was to automate IP addresses assignment.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_37.png]]
−
Here we will show you how to set up its configuration. In order to start, go to '' 'Configuration' '' → '' 'Create Configuration'. ''<br />
+
−
Type your configuration name, press textboxes corresponding to options you wish to add and select them from dropdown menus:
+
−
*Products
+
−
*Addons
+
−
*Servers
+
−
*Config Options<br/>
+
−
Afterwards, press '' 'Create New Configuration' '' button. On the screen below you can see sample configuration with two products selected.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_45.png]]
+
|style="padding: 0px 0px 20px 15px;"|Afterwards, press '' 'Auto Generate Code' '', select type from a dropdown menu, enter value and save through pressing '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Now you have to assign at least one subnet to configuration. Use '' 'Assigned Subnets' '' button.<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_38.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_46.png]]
+
|style="padding: 0px 0px 15px 15px;"|Your promotion is ready to use, let's assign it to some user.<br />
 +
Go to '' 'Addon' '' → '' 'Domains Reseller' '' → '' 'API User' '' and press '' 'Assign Promocode' '' next to the user you want to assign the promotion for.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Choose a subnet from a dropdown menu and press '' 'Assign Subnet' '' button.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_39.png]]
−
Keep in mind that you can assign multiple subnets to a single configuration.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_47.png]]
+
|style="padding: 0px 0px 20px 15px;"|Now select the previously created promotion and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|See the list of subnets assigned to your configuration.
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_40.png]]
−
*Press Subnet address to see its details
+
−
*Manage additional Information: nameservers, gateway
+
−
*Check usage
+
−
*Remove subnet from the list
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_47_1.png]]
+
|style="padding: 0px 0px 20px 15px;"|You should see, that the promotion code appeared next to the client, as shown on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|On pressing subnet address you will be moved to its details. There you can manage single IP addresses that are created within this subnet.<br/>
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_41.png]]
−
 
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_47_2.png]]
+
 
|}
 
|}
  
−
===Advanced Configuration===
+
==API Logs==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let's say, that you want to set multiple IP assignment to specific product, it is available with our module!<br />
+
|style="padding: 10px 0px 15px 15px;"|You can display the logs of requests to the API. As well as responses to these requests and information about who sent the request to the API.<br />
−
Here we will show you how to set up multiple IP addresses assignment to configurable option '' 'Extra IP Addresses'. ''<br />
+
You can find the desired log using filters. Fields left empty will not be considered during the search.
−
Create a new configuration as while setting up a standard configuration.<br />
+
−
Once it is  done press '' 'Configurable Options' '' as shown on the screen below.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_48.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_42.png]]
 
|}
 
|}
 +
==Module Generator==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterwards, mark checkboxes next to configurable options you want to assign IP addresses to.<br />
+
|style="padding: 10px 0px 15px 15px;"|Rebranding registrar module has never been easier. With our generator all you have to do is fill in its name and press '' 'Generate Module' ''.<br />
−
Enter quantity of IP addresses which will be assigned to each configurable option and press '' 'Save Changes'. ''
+
''Note: You can generate registrar module both for WHMCS and HostBill systems.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_49.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_43.png]]
 
|}
 
|}
−
 
−
====Usage Statistics====
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In each configuration you can find a graph, which shows the statistics of IP addresses assignment.
+
|style="padding: 0px 0px 15px 15px;"|As soon as you do that, the module will be generated. Save the link to it and copy installation instructions.<br />
 +
'''Important:''' As soon as the new module is generated, integration code for it will appear as the 5th step of installation instruction<br />
 +
It is crucial to save the code and deliver it to resellers in installation instructions along with the link to the module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_50.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_44.png]]
 
|}
 
|}
  
−
==3rd Party Integration==
+
==Response Templates==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|In this tab you can set up 3rd party integration which allows you to manage IP through our module in your WHMCS and synchronize changes on 3rd party servers.<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/>  
−
''Note 1: Some of these integration submodules require free IP subnets (cPanel) or IP addresses (Plesk) on servers to be set up.''<br />
+
In order to add a new response template press '' Add '' button and then follow the below instructions.
−
''Note 2: IP Manager can integrate multiple IP addresses with a single product.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_50_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_56.png]]
 
|}
 
|}
−
===Enabling 3rd Party Integration===
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"| Activation of all integration modules looks similar, there is only a difference in cPanel and cPanel Extended integration submodules.<br />
+
|style="padding: 0px 0px 15px 15px;"|Provide the pattern for search and replace in the system response depending on the type.<br>
−
Start by pressing '' 'Activate' '' button next to a module you want to activate.
+
*For '''Text''' type, simply provide a string like '' 'Error Response'. ''<br/>
 +
*For '''Regular Expression''' type, you need to provide a regular expression which will be replaced.<br/> ''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'.<br/>
 +
*If you want to replace '''any response,''' simply type '.+' in here.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_51.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_57.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"| Press '' 'Configure' '' button and assign configurations to it.<br />
+
|style="padding: 0px 0px 15px 15px;"|In he 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.
−
Confirm through clicking '' 'Save Changes'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_52.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_58.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"| cPanel and cPanel Extended additionally allow you to choose the method of the integration.<br />
+
|style="padding: 0px 0px 15px 15px;"|Finally,
−
* Creates a DNS zone for each IP address assigned to a product.
+
*define '''Priority''':<br>
−
* The first IP address assigned to a product is set up as a site dedicated IP address.  
+
''Higher number means higher priority. Please note that only the first occurrence with the highest priority will be replaced.<br/> It means that if there are 2 patterns found with priority 20 and 10, only pattern with priority 20 will be replaced.''<br/>
 +
*choose '' 'Text' '' or '' 'Regular Expression' '' from '''Type''' dropdown menu<br/> 
 +
''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 '' 'Add' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_53.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_59.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"| As you can see on the following screen, you can easily check the quantity of configurations assigned to each 3rd party integration.
+
|style="padding: 0px 0px 15px 15px;"|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.<br/> Just use action buttons marked on the screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_54.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_60.png]]
 
|}
 
|}
  
−
===Integration With Proxmox VPS/Cloud For WHMCS===
+
==Documentation==
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Integration with Proxmox VPS For WHMCS & Proxmox Cloud For WHMCS are the only integrations which are set up on both IP Manager For WHMCS and integrated module sides.<br />
+
|style="padding: 10px 0px 20px 15px;"|This tab is a hyperlink. It leads to Domains Reseller For WHMCS Wiki article you are currently reading.
−
Due to that, setting up the integration consists of 3 steps:<br />
+
−
1. Create IP addresses subnet which will be used for product.<br />
+
−
2. Create configuration and assign a previously created subnet to it. '''No additional action is required in this step.'''<br />
+
−
'''Important: Assigning anything beyond the Subnet to the configuration in IP Manager For WHMCS may cause unexpected effect in your WHMCS environment.'''
+
 
|}
 
|}
−
===Integration With SolusVM Extended VPS For WHMCS===
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Integration with SolusVM Extended VPS For WHMCS is tricky.<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_45.png]]
−
IP Manager For WHMCS cannot inject the first IP address to VPS, due to the way SolusVM API works.<br />
+
−
After creation of VPS, IP Manager is able to add additional IP addresses.<br />
+
−
Therefore, if you are using this integration, we advise setting up IP Manager synchronization as a cron job.
+
 
|}
 
|}
−
===Test Integration Module===
+
==Email To Reseller==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|This module logs information about IP processing for '' 'Autorelease' '' type products.<br />
+
|style="padding: 10px 0px 30px 15px;"|Email to your reseller should consist of:<br />
−
Your order should look similar to the one on the screen below.<br />
+
1. Registrar module you generated or link to its download.<br />
−
''Note: You need to set up '' 'Autorelease' '' type server, otherwise logs will not show up.''
+
2. Installation instructions (with integration code).<br />
−
|}
+
3. Connection credentials (user API key and email).
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM19.1.png]]
+
 
|}
 
|}
  
−
===Creation of Integration Submodule===
+
==Provider Client Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can create your own integration, all you need is knowledge of PHP programming language.<br />
+
|style="padding: 10px 0px 15px 15px;"|Resellers can manage API connection credentials directly from the provider WHMCS client area.<br />
−
You can do it through using '' 'Autorelease' '' submodule file.<br />
+
Go to '' 'Domains' '' → '' 'Reseller Registrar Credentials' '' to access them.
−
1. To begin, make copy of '' 'AutorelaseIntegration.php' '' located in '' 'your_whmcs/modules/addons/IPM2_anager2/app/modules'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM19.2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_46.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|2. Rename copy to your new submodule name.<br />
+
|style="padding: 0px 0px 15px 15px;"|As you can see, you can find all the information linked with your registrar.<br />
−
''Note: File name has to end with 'Integration', for example 'NewSubmoduleIntegration.php'.''
+
To view your API key, press '' 'Show' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM19.3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_47.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|3. Edit the file, start by entering basic settings.
+
|style="padding: 0px 0px 20px 15px;"|If your API key was exposed, generate a new one through pressing '' 'Generate Key' ''.
−
1. Class name should be the same as the file name.
+
−
2. Submodule name visible in IP Manager.
+
−
3. Submodule description displayed in IP Manager.
+
−
4. Place here an integrating module name ( the best way is to copy a folder name of the module ).
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM19.4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_48.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|4. Now, it is time to implement integration part, you will need integrated module documentation to do that.
+
−
1. Configuration of 3rd party integration submodule.
+
−
2. Code assigning IP address to module product goes here.
+
−
3. You can add a code to unassign IP address here.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM19.5.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|4. In order to view a submodule you have just created, log in to your WHMCS and go to '' 'Addons' '' → '' 'IP Manager' '' → '' '3rd Party Integration'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_56.png]]
+
 
|}
 
|}
  
−
==Export==
+
==End User Client Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can export your subnets with IP addresses to CSV and XML files.<br />
+
|style="padding: 10px 0px 15px 15px;"|Domains Reseller registrar module allows an end user to register, transfer and renew domain.<br />
−
To export, go to '' 'Export' '' tab, choose subnet to export and output format.<br />
+
Client can also manage private nameservers (1), enable/disable ID protection (2), modify contact information (3), manage DNS records (4) and set up email forwarding (5).
−
Now you can '' 'Generate' '' the file. Download of the file will start shortly.<br />
+
−
''Note: Your '' 'storage' '' folder located in 'your_whmcs/modules/addons/IPM2_anager2' should have chmod set to '''755'''.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_62.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_49.png]]
 
|}
 
|}
−
 
−
==Import==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In '' 'Import' '' tab you can find tools to synchronize IP addresses from your WHMCS as well as import them from a file.<br />
+
|style="padding: 0px 0px 20px 15px;"|At the '' 'Register Nameservers' '' (1) you can manage your custom nameservers.
−
'''Synchronization'''<br />
+
−
Synchronization will confirm relations in your system with relations in IP Manager subnets.
+
−
*IP address is used by a product, but inside of IP Manager subnet it is marked as unassigned - record inside of a subnet will be updated.
+
−
*IP address is used by a product, but does not exist in any IP Manager subnet - a new subnet will be created.
+
−
There are three available cron commands:<br />
+
−
1. This cron command synchronizes all products (it will require confirmation).<br />
+
−
2. This cron command synchronizes all products (it will not require any confirmation).<br />
+
−
3. This cron command synchronizes only products which IDs have been provided as arguments separated by comma.<br />
+
−
'''Import'''<br />
+
−
To import IP addresses from a file, select it, choose its format and press '' 'Import'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_63.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_50.png]]
 
|}
 
|}
−
 
−
==IP Logs==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'' 'Logs' '' page stores the history of actions ordered on each IP address.
+
|style="padding: 0px 0px 20px 15px;"|To enable/disable ID protection (2), proceed to the '' 'Addons' '' subtab.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM2_64.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_51.png]]
 
|}
 
|}
−
 
−
 
−
==Integration Code==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''Integration described below is not obligatory.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|At '' 'Contact Information' '' (3) you can decide which contact information use: yours, your contact or custom information.
−
Module allows your customers to view IP addresses assigned to their product and order additional ones.<br />
+
−
To enable it, follow these simple steps:
+
 
|}
 
|}
−
====Integration in WHMCS V6====
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 25px;"|[[File:IPM2_65.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_52.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Correctly placed code is presented on the following screen.  
+
|style="padding: 0px 0px 15px 15px;"|'' 'Manage DNS' '' (4) allows you to manage your DNS records.<br />
 +
On the following screen you can find information '' 'Function Not Supported by Registrar Module' '', it informs you that the registrar module used at the Provider WHMCS does not support this feature.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_66.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_53.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In the client area it should look like on the screen below.
+
|style="padding: 0px 0px 20px 15px;"|At the '' 'Manage Email Forwards' '' (5) you can redirect your emails to another domain.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_67.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:DR_54.png]]
 
|}
 
|}
−
====Integration in WHMCS V5====
+
==Workflow==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 25px;"|[[File:IPM2_68.png]]
+
|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 characters take part:<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 />
 +
Additionally, the reseller has its own system with registrar generated by Domains Reseller For WHMCS.<br />
 +
'''End-Customer''' – a person with a client account in the Reseller's system.<br />
 +
<br />
 +
Additionally, there also must be a product, which in this case will be domain 'sample.com' .<br />
 +
<br />
 +
'''Provider Part'''<br />
 +
Let's 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 />
 +
Now, the provider configures Domains Reseller For WHMCS through enabling its API and enabling .com TLD for API.<br />
 +
Afterwards, he or she proceeds to API Users, enables Reseller and generates API key for them.<br />
 +
Additionally, he or she assigns a 10% discount for Reseller under API Users tab.<br />
 +
'''Reseller'''<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 form 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 />
 +
He or she also sets up .com TLD in the system and assigns the previously installed registrar to it.<br />
 +
Now, there is one step that separates them from offering the domain from their system.<br />
 +
Reseller top-up 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 />
 +
Form now on, any .com domain can be ordered.<br />
 +
'''End-Customer'''<br />
 +
End-Customer 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 />
 +
<br />
 +
'''Last Word About Payment'''<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 />
 +
Credits withdrawn are equal to a domain price in the Provider system minus the promocode assigned to the Reseller.<br />
 
|}
 
|}
 +
==Extended TLDs Management - Integration With [http://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS Domain Orders Extended For WHMCS]==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Correctly placed code is presented on the following screen.  
+
|style="padding: 10px 0px 15px 15px;"|Owing to the integration with Domain Orders Extended For WHMCS, the management of multiple TLDs and offering them to your resellers is even easier!<br />
 +
We will show the exemplary workflow of such an integration.<br />
 +
Install one of gTLD groups at the Domain Orders Extended For WHMCS.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_69.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_54_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In the client area it should look like on the screen below.
+
|style="padding: 0px 0px 20px 15px;"|Use grouping by categories to select all TLDs from a previously created '' 'Business' '' group and press '' 'Bulk Set Pricing' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_70.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_54_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|To allow your customers to buy a new IP address you need to set up a product addon for product and assign the addon to a configuration in IP Manager.
+
|style="padding: 0px 0px 15px 15px;"|Next step is setting up pricing. We are still using Domain Orders Extended For WHMCS.<br />
 +
On the following screen we are copying pricing from a previously created TLD.<br />
 +
You can find more information about the pricing in Domain Orders Extended For WHMCS [http://www.docs.modulesgarden.com/Domain_Orders_Extended_For_WHMCS#Pricing here].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|The above described integration works for all products without exception.<br/> However, in case you wish to restrict the integration to limited number of products, please insert the below codes instead of the one suggested in the addon. <br/><br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_54_3.png]]
−
<code>
+
−
{if $moduleclientarea}
+
−
  &lt;div class="moduleoutput"&gt;;{$moduleclientarea|replace:'modulebutton':'btn'}
+
−
  {if $pid == 26 || $module ==  'proxmoxCloud' || $module == 'proxmoxVPS'}
+
−
        {$IPM2_anager_integration}
+
−
  {/if}
+
−
  &lt;/div&gt;
+
−
{/if}
+
−
</code>
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Once such code is inserted in the template, IP Manager will be displayed for product with ID that equals 26 or if the product is based on '' 'proxmoxCloud/proxmoxVPS' '' modules.<br/> Extend the IP Manager integration according to your needs. The above code is just an example which can undergo modifications.  
+
|style="padding: 0px 0px 15px 15px;"|Select all TLDs the same way you did earlier and press '' 'Bulk Registrar Change' ''.<br />
 +
Afterwards, select a registrar which can provision gTLDs domains and press '' 'Update Registrars' ''.
 
|}
 
|}
−
 
−
==Client Area==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Your clients can view and manage their IP addresses and subnets thanks to installed IP Manager For WHMCS module.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_54_4.png]]
−
To remove any IP address or subnet from a product, simply press '' 'Unassign' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_71.png]]
+
|style="padding: 0px 0px 15px 15px;"|Now, enable previously configured TLDs at your Domains Reseller → '' 'Configuration' '' tab.<br />
 +
TLDs are ready to be offered by your resellers.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Your client can also order a new IP address.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_54_5.png]]
−
Press '' 'Order Additional IP Addresses' '' as shown below.<br />
+
−
Your client will be moved to order form containing previously configured addons.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_72.png]]
+
|style="padding: 0px 0px 15px 15px;"|One of your reseller also own Domain Orders Extended For WHMCS, he can quickly update his offer by installing the same gTLD category.<br />
 +
Afterwards, he can set up pricing and assign them to use Domains Reseller For WHMCS registrar module generated by you in the same way you did.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|As soon as the addon is active, new IP address is granted.
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_54_6.png]]
 
|}
 
|}
−
 
−
==Add IP via Addon==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Setting up an addon allows your client to add an IP address to their product using integration.<br />
+
|style="padding: 0px 0px 20px 15px;"|Additionally, his offer is more client-friendly due to the custom Domain Orders Extended domain registration form.
−
Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Product Addons' '' and press '' 'Add New Addon' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_74.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_54_7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Afterwards, enter addon name, addon description and select applicable products.<br />
+
|style="padding: 0px 0px 15px 15px;"|There is also no problem for resellers who do not own Domain Orders Extended.<br />
−
Set pricing for addon by choosing '' 'Billing Cycle' '' and typing price.<br />
+
However they have to add and set up each TLD separately at the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domain Pricing' '', which may be time consuming.
−
Confirm through pressing '' 'Save Changes' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_75.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_54_8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now, go to '' 'Addons' '' → '' 'IP Manager' '' and use configuration created before or [http://www.docs.modulesgarden.com/IP_Manager_For_WHMCS#Automatic_IP_Assignment create a new one].<br />
+
|style="padding: 0px 0px 30px 15px;"|As you saw, an integrating of Domains Resellers For WHMCS and Domain Orders Extended For WHMCS allows you to offer vast array of TLDs with ease.<br />
−
Remember to add a previously created addon as a configuration relation.<br />
+
Your resellers can also benefit from such an integration, beside management of the TLDs, they end clients can benefit from user-friendly domain order form as well as domain spinner.<br />
−
You can do it by pressing '' 'Addon' '' button as shown on the following screen.
+
All of this breed yours and your resellers' income to increase even more!
 
|}
 
|}
 +
 +
=Tips=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_76.png]]
+
|style="padding: 10px 0px 0px 15px;"|1. If you forget to save the link to the registrar module you generated or integration code for it, do not worry, there is a way!<br />
 +
Simply generate the module with the same name and save what you forgot to save the last time.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Tick checkbox next to addon and enter the quantity of IP addresses to be added.<br />
+
|style="padding: 10px 0px 20px 15px;"|2. If your reseller gets an error '' 'Unable to register domain, please contact administration (license problem).' '', that means your license is invalid or expired.
−
Afterwards, click '' 'Save Changes' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:IPM2_77.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:DR_55.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|If you enabled integration for the client area, your client should be able to order new IP addresses.
+
|style="padding: 0px 0px 20px 15px;"|3. Make sure that you are not blocking access to the '' 'domainsResellerAPI' '' catalog by your '' '.htaccess' '' file.
 
|}
 
|}
−
==Management of Custom Hooks==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Our module allows you to use custom hooks. All you have to do is create some functions using PHP programming language.<br />
+
|style="padding: 0px 0px 20px 15px;"|4. Domains Reseller For WHMCS enables you to resell your domains not only to WHMCS and HostBill systems.<br />
−
Here you can see possible hooks:
+
You are able to easily prepare registrar module for any system (Blesta, Clientexec, BoxBilling and many more) using Domains Reseller For WHMCS API.<br />
−
before_ip_assign_hook($ip, $serviceid, $relation, $configid)
+
All you need is knowledge of for example PHP programming language and [[#Knowledgebase|knowledgebase]] of our module's API.
−
after_ip_assign_hook($ip, $serviceid, $relation, $configid)
+
−
before_ip_integrating_hook($ip, $service, $server)
+
−
after_ip_integrating_hook($ip, $service, $server)
+
−
before_ip_disintegrating_hook($ip, $service, $server)
+
−
after_ip_disintegrating_hook($ip, $service, $server)
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|To find details about hooks read '' 'custom_hooks.php' '' file.<br />
+
−
You can find there all hooks, information about their time of run, returned values and parameters.<br />
+
−
For example, if you want to throw message to activity log after IP address assignment find hook '' 'after_ip_assign_hook($ip, $serviceid, $relation, $configid)' '' and type:
+
−
Logger::factory()->log('Custom hook was triggered');
+
−
It should look like on the screen below:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:IPM_59.png]]
+
−
|}
+
−
 
+
−
==How To Update==
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|In order to upgrade your module, follow [[Modules_Update|Modules Update]] article.
+
−
|}
+
−
 
+
−
=Tips=
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|1. If your client orders a product that is combined with two configurations (e.g. by product type and configurable option), IP Manager will add IP addresses from both configurations.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|2. If you have used IPv6 block before the update to IP Manager 2.2.0, all of them will be migrated to corresponding subnets. Note that migration is done automatically for you.
+
 
|}
 
|}
  
Line 898: Line 741:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|2. If you see something like this when moving to '' 'Addon' '' → '' 'IP Manager', '' remove content of '' 'template_c' '' folder.
+
|style="padding: 0px 0px 30px 15px;"|2. Error '' 'Function Not Supported by Registrar Module' '' means that registrar on main WHMCS does not support the operation you were trying to do.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 25px;"|[[File:IPM_60.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 15px;"|3. If you export file and it is empty, check your '' 'Storage' '' folder chmod, it should be set to '''755'''. Folder is located in '' 'your_whmcs/modules/addons/IPM2_anager2' ''.<br />
+
−
If you still have that problem, set chmod '''777'''.  
+
 
|}
 
|}

Revision as of 14:18, 16 December 2015


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.
Just generate your own registrar module with just a couple of clicks, hand it over to your resellers and admire the sales they generate.

  • Provider Features:
✔ Your Own API For Domains Reselling
✔ Domain Registrar Module Generator For WHMCS & HostBill
✔ Enable/Disable API
✔ API Status
✔ Restrict IP Addresses
✔ Reseller White List
✔ Restrict IP Address Per Client
✔ Auto Disable API For New Users
✔ Auto Generate API Key For New Users
✔ SSL Connection
✔ Low Credit Notification
✔ Choose TLDs Enabled For API
✔ Allow Reselling And Activating Domains For Chosen Clients Without Credits
✔ Define Type Of Refund Upon Unsuccessful Domain Registration
✔ List Of Clients With Possibility To Generate/Remove/Enable/Disable The API Key
✔ Generate/Enable/Disable API Keys For All Users
✔ Filtering API Users Per Firstname, Lastname And E-mail
✔ Assign Promocodes To Users
✔ API Knowledgbase Generator
✔ API Logs With Filtering
  • API Functionality:
✔ Register/Transfer/Renew Domain
✔ Release/Delete Domain
✔ Modify Contact Details
✔ Get EPP Code
✔ Get/Save DNS Records
✔ Get/Modify Nameservers
✔ Register/Modify/Delete Nameserver
✔ Registrar Lock
✔ Get/Save Email Forwarding
✔ ID Protection
✔ Domain Cron Synchronization
  • End User Features:
✔ View Contact Information
✔ Manage Email Forwarders
✔ Manage DNS Records
✔ Register/Manage Private Nameservers
✔ Enable/Disable ID Protection
  • General Info:
✔ Orders Paid By Resellers' Credit
✔ Reseller Can Manage API From The WHMCS Client Area
✔ Integrated With Domain Orders Extended For WHMCS - Innovative Way Of Selling TLDs & gTLDS (read more)
✔ Multi-Language Support
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V5 and V6

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

1. Log in to your client area and download Domains Reseller For WHMCS.
DR 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

DR 2.png
3. When you install Domains Reseller 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' .

DR 3.png
4. 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 at your client area → 'My Products' .

DR 4.png
5. Edit 'header.tpl' file located at 'your_whmcs/templates/default/header.tpl' .

Important! This edition is required only if you use WHMCS V5x.x.
There are no alterations in templates for WHMCS V6x.x.
Add this code: 

{if $dr_show_button}<li><a href="index.php?m=domainsReseller">Reseller Registrar Credentials</a></li>{/if}

After: 

<li><a id="Menu-Domains-Whois_Lookup" href="domainchecker.php">{$LANG.navwhoislookup}</a></li>

Take a look at the screenshot below and verify your changes:

DR 5.png
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.

DR 6.png
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' .

DR 7.png
8. You have just successfully installed Domains Reseller!

You can access your module at 'Addons' → 'Domains Reseller' .
Now it's time to set up registrar module, it will be used by your resellers registrar to manage domains.

DR 8.png
9. Activate and configure registrar at 'Setup' → 'Products/Services' → 'Domains Registrar' .
DR 9.png
10. Go to 'Setup' → 'Products/Services' → 'Domains Pricing' .

Add TLD, set pricing for it and choose automatic registrar you have just configured.

DR 10.png
11. To generate registrar for your resellers, make sure that 'module_generator' folder has chmod set to '755' or '777'.

Folder is located in 'your_whmcs/modules/addons/domainsReseller/pages/ ' .

DR 11.png
12. Go to Domains Reseller addon and switch to 'Configuration' tab.

Mark checkbox next to TLD you want to resell and press 'Save Changes' button.

DR 12.png
13. In 'Module Generator' tab enter module name into textbox and press 'Generate Module' button.
DR 13.png
14. Downloading of the module you have just generated will start shortly.

You can provide registrar module for your resellers in two ways, by sending them a file or a link to it.
The link should appear right after the module has been generated.
Important: Save the link and the installation instruction marked on the screen below, it will not appear again.
Note: You have to provide integration code (step 5. of installation instructions) to your resellers.

DR 14.png
15. Now you have to generate API key for your client. Go to 'API Users' tab.

Afterwards, press 'Generate API Key' next to the user you want to generate API key for.
Note that API key and the user's email are needed as credentials at the registrar module you have just generated.

DR 15.png
Your Domains Reseller module is ready to use!

Your clients can use their registrars as soon as they install them on their WHMCS and add credits to their accounts in your WHMCS.

Module Installation - Reseller

Below you can find instructions for installation of the registrar module on reseller WHMCS.
1. Upload and extract the registrar module into your WHMCS.
DR 16.png
2. Enter integration code that you got from your provider.

Open 'additionaldomainfields.php' file located at 'includes/additionaldomainfields.php' .
Paste the code you received at the end of the file.

DR 17.png
3. Go to 'Setup' → 'Products/Services' → 'Domains Registrar' , find the module you have just uploaded and press 'Activate' next to it.
DR 18.png
4. Now, press 'Configure' button, enter 'User Email' and 'API Key' provided along with module.

Afterwards, press 'Save Changes' .

DR 19.png
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' .

DR 20.png
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 will not block it.

DR 21.png
7. Next, enter prices for specific actions. Press 'Save Changes' to confirm.
DR 22.png
8. Congratulations, you have just successfully installed your registrar!

You can start using registrar as soon as you add credits to your account on provider WHMCS.
If you order a domain using this registrar, you should see in your admin area something similar to the screen below.

DR 23.png

Configuration and Management

Domains Reseller For WHMCS allows your customers to resell domains on their own WHMCS.

Configuration

'Configuration' tab allows you to access general settings of your Domain Reseller API.
DR 24.png
We will describe these options below.

1. 'API Status ' - Enable/Disable Domains Reseller API.
2. 'Restricted By IP Addresses' - Enable/Disable restricting connection to Domains Reseller API only for IP addresses specified in the 'Allowed IP Addresses' field.
3. 'Allowed IP Addresses' - The list of IP addresses allowed to connect with Domains Reseller when 'Restrict IP Address' option is enabled.
Note: This option shows up only when ' 'Restrict IP Address' is enabled.
 4. 'Pay After Registration' - The list of resellers who are able to pay for a domain after its registration.
5. 'Pay After Order' - The list of resellers who are able to pay for a domain after ordering it.
6. 'Auto Disable API For New Users' - API will be disabled for newly created clients.
7. 'Auto Generate API Key For New Users' - API Key will be generated automatically when client's account is created.
8. 'SSL Connection' - You can define here, if connection with your API will use SSL or not. When you change it, you will need to generate a new registrars for your resellers.
9. 'Refund' - Defines behaviour of the module upon unsuccessful domain registration.
10. 'Low Credit Notification' - Notification to your client will be sent when credit balance on client's account falls below entered value.
Note 1: All changes should be saved, you can do it through pressing 'Save Changes' button.
Note 2: To sent an email notification about low credit balance, create a template 'Low Credit Notification' of 'General' type.

DR 25.png
To restrict access to the Domains Reseller API by IP address, simply choose 'Enable' from 'Restrict IP Addresses' dropdown menu.

New text field should appear, enter IP addresses you want to whitelist, one IP address per line.
At the end, press 'Save Changes' button.

DR 26.png
Last, but not least important thing you can do here is enabling TLD for resell.

It can be done simply by ticking TLD and pressing 'Save Changes' .

DR 27.png

API

At the 'API' tab you can find a lot of information about Domains Reseller API, as well as generate and share API knowledgebase.

Introduction

'Introduction' subtab contains information about actions supported by the API.
DR 28.png

Connection

In this subtab you can read about request and response data format as well as authentication.

You can also find URL to the API here.

DR 29.png

Examples

Here you can find sample API request and response.
DR 30.png

Knowledgebase

'Knowledgebase' subtab allows you to generate API knowledgebase for your resellers in your WHMCS client area and locate link to it (if already generated).
DR 31.png
When your clients follow a link to the knowledgebase they should see something similar to the screen below.
DR 32.png

API Users

At the 'API Users' tab you can manage all aspects related to your resellers.

For your convenience we also implemented filters, you can use them to find a specific user or a group of users.
Note: Remember to set default payment method for every reseller. It can be set up at client profile in 'Payment Method' dropdown menu.

DR 33.png
You can set up IP restriction per client (1), assign a promotion code to a single user (2), generate a new key for them(3) or disable API for them (4).
DR 34.png
Our module also allows performing these actions for all clients at once.
DR 35.png

IP Restriction

Let's ensure, that specific clients are able to connect with Domains Reseller API only from defined IP addresses.

Press 'IP Restriction' , fill in IP address and press 'Save' .
Note: To add multiple IP addresses, press 'Add Field' .

DR 36.png

Assigning Promotion Codes

You can create and assign promotion codes to your users.

Firstly, go to 'Setup' → 'Payments' → 'Promotions' and press 'Create New Promotion' .

DR 37.png
Afterwards, press 'Auto Generate Code' , select type from a dropdown menu, enter value and save through pressing 'Save Changes' .
DR 38.png
Your promotion is ready to use, let's assign it to some user.

Go to 'Addon' → 'Domains Reseller' → 'API User' and press 'Assign Promocode' next to the user you want to assign the promotion for.

DR 39.png
Now select the previously created promotion and press 'Save Changes' .
DR 40.png
You should see, that the promotion code appeared next to the client, as shown on the following screen.
DR 41.png

API Logs

You can display the logs of requests to the API. As well as responses to these requests and information about who sent the request to the API.

You can find the desired log using filters. Fields left empty will not be considered during the search.

DR 42.png

Module Generator

Rebranding registrar module has never been easier. With our generator all you have to do is fill in its name and press 'Generate Module' .

Note: You can generate registrar module both for WHMCS and HostBill systems.

DR 43.png
As soon as you do that, the module will be generated. Save the link to it and copy installation instructions.

Important: As soon as the new module is generated, integration code for it will appear as the 5th step of installation instruction
It is crucial to save the code and deliver it to resellers in installation instructions along with the link to the module.

DR 44.png

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 Add button and then follow the below instructions.

DR 56.png
Provide the pattern for search and replace in the system response depending on the type.
  • 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.
DR 57.png
In he 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.
DR 58.png
Finally,
  • define Priority:

Higher number means higher priority. Please note that only the first occurrence with the highest priority will be replaced.
It means that if there are 2 patterns found with priority 20 and 10, only pattern with priority 20 will be replaced.

  • 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 'Add' button.

DR 59.png
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.
DR 60.png

Documentation

This tab is a hyperlink. It leads to Domains Reseller For WHMCS Wiki article you are currently reading.
DR 45.png

Email To Reseller

Email to your reseller should consist of:

1. Registrar module you generated or link to its download.
2. Installation instructions (with integration code).
3. Connection credentials (user API key and email).

Provider Client Area

Resellers can manage API connection credentials directly from the provider WHMCS client area.

Go to 'Domains' → 'Reseller Registrar Credentials' to access them.

DR 46.png
As you can see, you can find all the information linked with your registrar.

To view your API key, press 'Show' button.

DR 47.png
If your API key was exposed, generate a new one through pressing 'Generate Key' .
DR 48.png

End User Client Area

Domains Reseller registrar module allows an end user to register, transfer and renew domain.

Client can also manage private nameservers (1), enable/disable ID protection (2), modify contact information (3), manage DNS records (4) and set up email forwarding (5).

DR 49.png
At the 'Register Nameservers' (1) you can manage your custom nameservers.
DR 50.png
To enable/disable ID protection (2), proceed to the 'Addons' subtab.
DR 51.png
At 'Contact Information' (3) you can decide which contact information use: yours, your contact or custom information.
DR 52.png
'Manage DNS' (4) allows you to manage your DNS records.

On the following screen you can find information 'Function Not Supported by Registrar Module' , it informs you that the registrar module used at the Provider WHMCS does not support this feature.

DR 53.png
At the 'Manage Email Forwards' (5) you can redirect your emails to another domain.
DR 54.png

Workflow

In this section we will present to you a sample workflow of the module.

In a basic workflow 3 characters take part:
Provider – a person with Domains Reseller For WHMCS installed in their system.
Reseller - a person with a client account in the provider's WHMCS system.
Additionally, the reseller has its own system with registrar generated by Domains Reseller For WHMCS.
End-Customer – a person with a client account in the Reseller's system.

Additionally, there also must be a product, which in this case will be domain 'sample.com' .

Provider Part
Let's start from the beginning. Provider installs Domains Reseller For WHMCS in the system.
He or she already has a few TLDs in the offer and wishes to allow the reseller to offer them from their systems.
Now, the provider configures Domains Reseller For WHMCS through enabling its API and enabling .com TLD for API.
Afterwards, he or she proceeds to API Users, enables Reseller and generates API key for them.
Additionally, he or she assigns a 10% discount for Reseller under API Users tab.
Reseller
From this moment, Reseller is able to access API details from the client account in the Reseller area.
Additionally, he or she receives an email form the Provider with registrar module and instruction on how to install it .
Reseller installs the registrar in the system according to the instruction received.
He or she also sets up .com TLD in the system and assigns the previously installed registrar to it.
Now, there is one step that separates them from offering the domain from their system.
Reseller top-up his credit balance in the provider system.
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.
Form now on, any .com domain can be ordered.
End-Customer
End-Customer orders 'sample.com' domain from his or her client area in the Reseller system.
They are now able to fully manage the domain.

Last Word About Payment
Payment goes to the Reseller while, during registration process, credits from Reseller balance are withdrawn.
It is worth mentioning that the amount a customer paid is defined by a Reseller.
Credits withdrawn are equal to a domain price in the Provider system minus the promocode assigned to the Reseller.

Extended TLDs Management - Integration With Domain Orders Extended For WHMCS

Owing to the integration with Domain Orders Extended For WHMCS, the management of multiple TLDs and offering them to your resellers is even easier!

We will show the exemplary workflow of such an integration.
Install one of gTLD groups at the Domain Orders Extended For WHMCS.

DR 54 1.png
Use grouping by categories to select all TLDs from a previously created 'Business' group and press 'Bulk Set Pricing' .
DR 54 2.png
Next step is setting up pricing. We are still using Domain Orders Extended For WHMCS.

On the following screen we are copying pricing from a previously created TLD.
You can find more information about the pricing in Domain Orders Extended For WHMCS here.

DR 54 3.png
Select all TLDs the same way you did earlier and press 'Bulk Registrar Change' .

Afterwards, select a registrar which can provision gTLDs domains and press 'Update Registrars' .

DR 54 4.png
Now, enable previously configured TLDs at your Domains Reseller → 'Configuration' tab.

TLDs are ready to be offered by your resellers.

DR 54 5.png
One of your reseller also own Domain Orders Extended For WHMCS, he can quickly update his offer by installing the same gTLD category.

Afterwards, he can set up pricing and assign them to use Domains Reseller For WHMCS registrar module generated by you in the same way you did.

DR 54 6.png
Additionally, his offer is more client-friendly due to the custom Domain Orders Extended domain registration form.
DR 54 7.png
There is also no problem for resellers who do not own Domain Orders Extended.

However they have to add and set up each TLD separately at the 'Setup' → 'Products/Services' → 'Domain Pricing' , which may be time consuming.

DR 54 8.png
As you saw, an integrating of Domains Resellers For WHMCS and Domain Orders Extended For WHMCS allows you to offer vast array of TLDs with ease.

Your resellers can also benefit from such an integration, beside management of the TLDs, they end clients can benefit from user-friendly domain order form as well as domain spinner.
All of this breed yours and your resellers' income to increase even more!

Tips

1. If you forget to save the link to the registrar module you generated or integration code for it, do not worry, there is a way!

Simply generate the module with the same name and save what you forgot to save the last time.

2. If your reseller gets an error 'Unable to register domain, please contact administration (license problem).' , that means your license is invalid or expired.
DR 55.png
3. Make sure that you are not blocking access to the 'domainsResellerAPI' catalog by your '.htaccess' file.
4. Domains Reseller For WHMCS enables you to resell your domains not only to WHMCS and HostBill systems.

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

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.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Hosting_Quota_Notifications_1.X_For_WHMCS&oldid=22229"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community