|
|
| (830 intermediate revisions by 6 users not shown) |
| Line 1: |
Line 1: |
| − | <meta name="keywords" content="domains reseller for whmcs, domains reseller configuration, whmcs domains reseller management, whmcs domains reseller installation, whmcs domains reseller common problems, about whmcs domains reseller, whmcs domains reseller documentation, whmcs domains reseller faq, whmcs domains reseller help, whmcs domains reseller guide, whmcs domains reseller wiki, whmcs domains reseller tutorial, whmcs domains reseller tips, whmcs domains reseller wiki"></meta> | + | <meta name="keywords" content="hosting quota notifications for whmcs, hosting quota notifications configuration, whmcs hosting quota notifications management, whmcs hosting quota notifications installation, whmcs hosting quota notifications common problems, about whmcs hosting quota notifications, whmcs hosting quota notifications documentation, whmcs hosting quota notifications faq, whmcs hosting quota notifications help, whmcs hosting quota notifications guide, whmcs hosting quota notifications wiki, whmcs hosting quota notifications tutorial, whmcs hosting quota notifications tips, whmcs hosting quota notifications wiki"></meta> |
| − | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Domains Reseller For WHMCS Module."></meta> | + | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Hosting Quota Notifications For WHMCS Module."></meta> |
| | | | |
| − | | + | =About [https://www.modulesgarden.com/products/whmcs/hosting-quota-notifications Hosting Quota Notifications For WHMCS]= |
| − | =About [http://www.modulesgarden.com/products/whmcs/domains_reseller/features Domains Reseller For WHMCS]= | + | |
| | {| | | {| |
| − | |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 /> | + | |style="padding: 10px 0px 10px 0px;"|'''Hosting Quota Notifications For WHMCS''' allows you to send automatic notifications to your clients whenever they exceed previously set bandwidth or disk usage. |
| − | 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 />
| + | Notifications can be sent in two ways: upon exceeding given resource tier or after exceeding given resource limit in a specified time period.<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.
| + | You can also define email templates and view details of each sent notification owing to logs. |
| | |} | | |} |
| | <!--a comment maybe? --> | | <!--a comment maybe? --> |
| − | *'''Provider Features:''' | + | *'''Admin Area Features:''' |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Your Own API For Domains Reselling | + | |style="padding: 10px 0px 0px 30px;"|✔ Automatically Notify Your Clients Upon Exceeding Defined Limits Of Bandwidth And Disk Usage |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Domain Registrar Module Generator For WHMCS & HostBill | + | |style="padding: 0px 0px 0px 30px;"|✔ Configure Notification Groups |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable API | + | |style="padding: 0px 0px 0px 30px;"|✔ Choose Between Two Types Of Group Counting: |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ API Status | + | |style="padding: 0px 0px 0px 45px;"|✔ Tiered - Define Tiers Of Usage |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Restrict IP Addresses | + | |style="padding: 0px 0px 0px 45px;"|✔ Fixed - Define Usage Grow Over Time |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Reseller White List | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Multiple Products To Single Notification Group |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Restrict IP Address Per Client | + | |style="padding: 0px 0px 0px 30px;"|✔ Assign Email Templates Per Notification Group |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Auto Disable API For New Users | + | |style="padding: 0px 0px 0px 30px;"|✔ Enable/Disable Notification Groups |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Auto Generate API Key For New Users
| + | |style="padding: 0px 0px 10px 30px;"|✔ View Logs Of Sent Notifications |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ SSL Connection
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Low Credit Notification
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Choose TLDs Enabled For API
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Allow Reselling And Activating Domains For Chosen Clients Without Credits
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define Type Of Refund Upon Unsuccessful Domain Registration
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ List Of Clients With Possibility To Generate/Remove/Enable/Disable The API Key
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Generate/Enable/Disable API Keys For All Users
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Filtering API Users Per Firstname, Lastname And E-mail
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Assign Promocodes To Users
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ API Knowledgbase Generator
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ API Logs With Filtering | + | |
| − | |}
| + | |
| − | *'''API Functionality:'''
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Register/Transfer/Renew Domain
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Release/Delete Domain
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Modify Contact Details
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Get EPP Code
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Get/Save DNS Records
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Get/Modify Nameservers
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Register/Modify/Delete Nameserver
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Registrar Lock
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Get/Save Email Forwarding
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ ID Protection
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Domain Cron Synchronization
| + | |
| − | |}
| + | |
| − | *'''End User Features:'''
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 0px 30px;"|✔ View Contact Information
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Manage Email Forwarders
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Manage DNS Records
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Register/Manage Private Nameservers
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 10px 30px;"|✔ Enable/Disable ID Protection
| + | |
| | |} | | |} |
| | *'''General Info:''' | | *'''General Info:''' |
| | {| | | {| |
| − | |style="padding: 10px 0px 0px 30px;"|✔ Orders Paid By Resellers' Credit | + | |style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Reseller Can Manage API From The WHMCS Client Area | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2 |
| | |} | | |} |
| | {| | | {| |
| − | |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)]
| + | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7 |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6 | + | |
| | |} | | |} |
| | | | |
| | =Installation= | | =Installation= |
| | {| | | {| |
| − | |style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure Domains Reseller For WHMCS.''' <br /> | + | |style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure Hosting Quota Notifications 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== | + | ==Installation== |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Domains Reseller For WHMCS.''' | + | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.''' |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_1.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_1.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br /> | + | |style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/> |
| − | Files in your WHMCS directory should look like this.
| + | '' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.''' |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_2.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |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 /> | + | |style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br /> |
| − | File is located in '' 'modules/addons/domainsReseller/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' .
| + | The content of PHP version files should look like this. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_3.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:drfere.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. When you install Hosting Quota Notifications For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> |
| − | 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' ''.
| + | File is located in '' 'modules/addons/hosting_quota_notifications/license_RENAME.php' '' . Rename it from '' 'license_RENAME.php' '' to '' 'license.php' '' . |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_4.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_3.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''5. Edit '' 'header.tpl' '' file located at '' 'your_whmcs/templates/default/header.tpl' ''.<br /> | + | |style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br /> |
| − | ''Important! This edition is required only if you use WHMCS V5x.x. <br/>There are no alterations in templates for WHMCS V6x.x.''<br/>
| + | Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area'' → 'My Products' ''. |
| − | 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 20px 25px;"|[[File:DR_5.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_4.png]] |
| | |} | | |} |
| | + | |
| | + | ==Configuration of Addon== |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|'''6. Now you have to activate the module in your WHMCS system. '''<br /> | + | |style="padding: 10px 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. | + | Log in to your WHMCS admin area. Go to '' 'Setup' '' → '' 'Addon Modules' ''. Afterwards, find '' 'Hosting Quota Notifications' '' and press '' 'Activate' '' button. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_6.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_5.png]] |
| | |} | | |} |
| | {| | | {| |
| | |style="padding: 0px 0px 15px 15px;"|'''7. In the next step you need to permit access to this module.'''<br /> | | |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' ''. | + | To do so click on '' 'Configure' '' button, tick '' 'Access Control' '' near required admin role groups and press '' 'Save Changes' ''. |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_7.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 20px 25px;"|[[File:DR_8.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|'''9. Activate and configure registrar at '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domains Registrar' ''.'''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_9.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''10. Go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domains Pricing' ''.'''<br />
| + | |
| − | Add TLD, set pricing for it and choose automatic registrar you have just configured.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_10.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |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 />
| + | |
| − | Folder is located in '' 'your_whmcs/modules/addons/domainsReseller/pages/ ' ''.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_11.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''12. Go to Domains Reseller addon and switch to '' 'Configuration' '' tab.'''<br />
| + | |
| − | Mark checkbox next to TLD you want to resell and press '' 'Save Changes' '' button.
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_12.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_6.png]] |
| | |} | | |} |
| | | | |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 15px;"|'''13. In '' 'Module Generator' '' tab enter module name into textbox and press '' 'Generate Module' '' button.''' | + | |style="padding: 0px 0px 15px 15px;"|'''8. You have just successfully installed Hosting Quota Notifications For WHMCS!'''<br /> |
| | + | You can access your module in '' 'Addons' '' → '' 'Hosting Quota Notifications' ''. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_13.png]]
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_7.png]] |
| − | |}
| + | |
| − | {|
| + | |
| − | |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:DR_14.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |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:DR_15.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |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.
| + | |
| − | |}
| + | |
| − | | + | |
| − | ==Module Installation - Reseller==
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 20px 15px;"|'''Below you can find instructions for installation of the registrar module on reseller WHMCS.'''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|'''1. Upload and extract the registrar module into your WHMCS.'''
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_16.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.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_17.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 20px 25px;"|[[File:DR_18.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''4. Now, press '' 'Configure' '' button, enter '' 'User Email' '' and '' 'API Key' '' provided along with module.'''<br />
| + | |
| − | Afterwards, press '' 'Save Changes' ''.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_19.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 15px 15px;"|'''5. To continue, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domains Pricing' ''.'''<br />
| + | |
| − | 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:DR_20.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |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:DR_21.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |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:DR_22.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |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 30px 25px;"|[[File:DR_23.png]] | + | |
| | |} | | |} |
| | | | |
| | =Configuration and Management= | | =Configuration and Management= |
| | {| | | {| |
| − | |style="padding: 10px 0px 30px 15px;"|'''Domains Reseller For WHMCS allows your customers to resell domains on their own WHMCS.''' | + | |style="padding: 10px 0px 30px 15px;"|'''In this section we will show you how to properly set up and use Hosting Quota Notifications For WHMCS.''' |
| | |} | | |} |
| | ==Configuration== | | ==Configuration== |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|'' 'Configuration' '' tab allows you to access general settings of your Domain Reseller API. | + | |style="padding: 10px 0px 15px 15px;"|In '' 'Configuration' '' page you can find the list of configured notification groups.<br /> |
| | + | You can enable/disable any of them, as well as alter or completely remove them.<br /> |
| | + | Press '' 'Create New Group' '' to proceed. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_24.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_9.png]] |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|We will describe these options below.<br /> | + | |style="padding: 0px 0px 15px 15px;"|Now, you can define all products related to this configuration and email template which will be used to notify your clients.<br /> |
| − | 1. '' 'API Status'' ' - Enable/Disable Domains Reseller API.<br />
| + | You can choose between two types of resource usage counting:<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 />
| + | *Fixed - define amount of resources over specific time period. If client usage growth has exceeded the given limit in specified time, a notification will be sent. |
| − | 3. '' 'Allowed IP Addresses' '' - The list of IP addresses allowed to connect with Domains Reseller when '' 'Restrict IP Address' '' option is enabled.<br />
| + | *Tiered - defines amount of resources. If client exceeds given limit, a notification will be sent. |
| − | ''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 25px;"|[[File:DR_25.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:HQN_10.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 /> | + | |style="padding: 0px 0px 15px 15px;"|For example, shown below module uses fixed counting type.<br /> |
| − | New text field should appear, enter IP addresses you want to whitelist, one IP address per line.<br />
| + | As you can see, we have defined limits for both bandwidth and disk.<br /> |
| − | At the end, press '' 'Save Changes' '' button.
| + | Settings shown below result in sending notification to client upon: |
| | + | *bandwidth usage growth by 5GB during 21 days. |
| | + | *disk usage growth by 100GB over period of 14 days. |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_26.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_11.png]] |
| | |} | | |} |
| | + | ==Logs== |
| | {| | | {| |
| − | |style="padding: 0px 0px 15px 15px;"|Last, but not least important thing you can do here is enabling TLD for resell.<br /> | + | |style="padding: 10px 0px 15px 15px;"|Under '' 'Logs' '' page you can view information about sent notifications. |
| − | It can be done simply by ticking TLD and pressing '' 'Save Changes' ''.
| + | |
| | |} | | |} |
| | {| | | {| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:DR_27.png]] | + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_12.png]] |
| | |} | | |} |
| − | ==API== | + | ==Notifications== |
| | {| | | {| |
| − | |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. | + | |style="padding: 10px 0px 15px 15px;"|You can create as many notifications as you wish.<br /> |
| | + | The only requirement is their type being set to '' 'Product/Service' ''.<br /> |
| | + | Additionally, you can use {if} statement, as shown below: |
| | + | {if $bw_over} Your bandwidth usage is over {$bw_over}MB{if $bw_current} (current: {$bw_current}MB){/if}.{/if} |
| | + | {if $disk_over}Your disks usage is over {$disk_over}MB{if $disk_current} (current: {$disk_current}MB){/if}.{/if} |
| | + | It will allow you to use this email template for bandwidth and disk notifications at the same time. |
| | |} | | |} |
| − | ===Introduction===
| |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|'' 'Introduction' '' subtab contains information about actions supported by the API.
| + | |style="padding: 0px 0px 30px 25px;"|[[File:HQN_13.png]] |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:DR_28.png]]
| + | |
| − | |}
| + | |
| − | ===Connection===
| + | |
| − | {|
| + | |
| − | |style="padding: 10px 0px 15px 15px;"|In this subtab you can read about request and response data format as well as authentication.<br />
| + | |
| − | You can also find URL to the API here.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:DR_29.png]] | + | |
| | |} | | |} |
| | | | |
| − | ===Examples=== | + | =Tips= |
| | {| | | {| |
| − | |style="padding: 10px 0px 20px 15px;"|Here you can find sample API request and response. | + | |style="padding: 10px 0px 30px 15px;"| |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:DR_30.png]]
| + | |
| − | |}
| + | |
| − | ===Knowledgebase===
| + | |
| − | {|
| + | |
| − | |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).
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_31.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|When your clients follow a link to the knowledgebase they should see something similar to the screen below.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:DR_32.png]]
| + | |
| − | |}
| + | |
| − | ==API Users==
| + | |
| − | {|
| + | |
| − | |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 20px 25px;"|[[File:DR_33.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |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:DR_34.png]]
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 20px 15px;"|Our module also allows performing these actions for all clients at once.
| + | |
| − | |}
| + | |
| − | {|
| + | |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:DR_35.png]]
| + | |
| − | |}
| + | |
| − | ===IP Restriction===
| + | |
| − | {|
| + | |
| − | |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:DR_36.png]]
| + | |
| | |} | | |} |
| | | | |
| − | ===Assigning Promotion Codes=== | + | =Update Instructions= |
| | {| | | {| |
| − | |style="padding: 10px 0px 15px 15px;"|You can create and assign promotion codes to your users.<br /> | + | |style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/> |
| − | Firstly, go to '' 'Setup' '' → '' 'Payments' '' → '' 'Promotions' '' and press '' 'Create New Promotion' ''.
| + | Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/> |
| | + | To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/> |
| | |} | | |} |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_37.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 25px;"|[[File:DR_38.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 20px 25px;"|[[File:DR_39.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Now select the previously created promotion and press '' 'Save Changes' ''.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_40.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 30px 25px;"|[[File:DR_41.png]]
| |
| − | |}
| |
| − |
| |
| − | ==API Logs==
| |
| − | {|
| |
| − | |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 />
| |
| − | You can find the desired log using filters. Fields left empty will not be considered during the search.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:DR_42.png]]
| |
| − | |}
| |
| − | ==Module Generator==
| |
| − | {|
| |
| − | |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 />
| |
| − | ''Note: You can generate registrar module both for WHMCS and HostBill systems.''
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_43.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:DR_44.png]]
| |
| − | |}
| |
| − |
| |
| − | ==Response Templates==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|In '' 'Response Templates' '' section you may add and edit new templates with text messages/information that are sent to clients instead of defined here system responses.<br/>
| |
| − | In order to add a new response template press '' Add '' button and then follow the below instructions.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_56.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|Provide the pattern for search and replace in the system response depending on the type.<br>
| |
| − | *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:DR_57.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_58.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|Finally,
| |
| − | *define '''Priority''':<br>
| |
| − | ''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:DR_59.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:DR_60.png]]
| |
| − | |}
| |
| − |
| |
| − | ==Documentation==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 20px 15px;"|This tab is a hyperlink. It leads to Domains Reseller For WHMCS Wiki article you are currently reading.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:DR_45.png]]
| |
| − | |}
| |
| − | ==Email To Reseller==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 30px 15px;"|Email to your reseller should consist of:<br />
| |
| − | 1. Registrar module you generated or link to its download.<br />
| |
| − | 2. Installation instructions (with integration code).<br />
| |
| − | 3. Connection credentials (user API key and email).
| |
| − | |}
| |
| − |
| |
| − | ==Provider Client Area==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|Resellers can manage API connection credentials directly from the provider WHMCS client area.<br />
| |
| − | Go to '' 'Domains' '' → '' 'Reseller Registrar Credentials' '' to access them.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_46.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|As you can see, you can find all the information linked with your registrar.<br />
| |
| − | To view your API key, press '' 'Show' '' button.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_47.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|If your API key was exposed, generate a new one through pressing '' 'Generate Key' ''.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:DR_48.png]]
| |
| − | |}
| |
| − |
| |
| − | ==End User Client Area==
| |
| − | {|
| |
| − | |style="padding: 10px 0px 15px 15px;"|Domains Reseller registrar module allows an end user to register, transfer and renew domain.<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).
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_49.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|At the '' 'Register Nameservers' '' (1) you can manage your custom nameservers.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_50.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|To enable/disable ID protection (2), proceed to the '' 'Addons' '' subtab.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_51.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|At '' 'Contact Information' '' (3) you can decide which contact information use: yours, your contact or custom information.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_52.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:DR_53.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|At the '' 'Manage Email Forwards' '' (5) you can redirect your emails to another domain.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 30px 25px;"|[[File:DR_54.png]]
| |
| − | |}
| |
| − | ==Workflow==
| |
| − | {|
| |
| − | |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: 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:DR_54_1.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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:DR_54_2.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 20px 25px;"|[[File:DR_54_3.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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' ''.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_54_4.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 20px 25px;"|[[File:DR_54_5.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 20px 25px;"|[[File:DR_54_6.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|Additionally, his offer is more client-friendly due to the custom Domain Orders Extended domain registration form.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_54_7.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 15px 15px;"|There is also no problem for resellers who do not own Domain Orders Extended.<br />
| |
| − | However they have to add and set up each TLD separately at the '' 'Setup' '' → '' 'Products/Services' '' → '' 'Domain Pricing' '', which may be time consuming.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_54_8.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |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 />
| |
| − | 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 />
| |
| − | All of this breed yours and your resellers' income to increase even more!
| |
| − | |}
| |
| − |
| |
| − | =Tips=
| |
| − | {|
| |
| − | |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: 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.
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 25px;"|[[File:DR_55.png]]
| |
| − | |}
| |
| − | {|
| |
| − | |style="padding: 0px 0px 20px 15px;"|3. Make sure that you are not blocking access to the '' 'domainsResellerAPI' '' catalog by your '' '.htaccess' '' file.
| |
| − | |}
| |
| − | {|
| |
| − | |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 />
| |
| − | You are able to easily prepare registrar module for any system (Blesta, Clientexec, BoxBilling and many more) using Domains Reseller For WHMCS API.<br />
| |
| − | All you need is knowledge of for example PHP programming language and [[#Knowledgebase|knowledgebase]] of our module's API.
| |
| − | |}
| |
| − |
| |
| | =Common Problems= | | =Common Problems= |
| | {| | | {| |
| − | |style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' | + | |style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.''' |
| − | |}
| + | |
| − | {|
| + | |
| − | |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.
| + | |
| | |} | | |} |
