Personal tools
Namespaces

Variants
Actions

Domains Reseller For WHMCS

From ModulesGarden Wiki
Revision as of 11:19, 30 October 2013 by Gregor (Talk | contribs)

Jump to: navigation, search

Contents

About Domains Reseller For WHMCS

Domains Reseller For WHMCS allows you to manage domains through registrar generated by our module.
  • Features:
✔ Set Different Rates For Different Payment Gateways (Percentage Or Fixed)
✔ Set Different Discounts For Different Payment Gateways (Percentage Or Fixed)
✔ Set Minimum Invoice Value To Charge Payments And Discounts
✔ Include/Exclude From Charges And Discounts Certain Clients
✔ Include/Exclude From Charges Certain Products, Addons, Domains And Other
✔ Automatic Conversion Of Charges And Discounts In Different Currencies
✔ PayPal Subscription Charging
✔ Apply Taxes On Charges
✔ Display/Hide Information About Additional Charges And Discounts During Ordering
✔ Integration With The Following Order Form Templates: Ajaxcart, Boxes, Cart, Comparison, Modern, Slider, Verticalsteps and Web20cart
  • Additionally:
✔ Easy Integration Which Automatically Adjusts To Each Order Form Template
✔ Multi-Language Support
✔ Supports WHMCS V5 and Later

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.

Provider WHMCS Module Installation

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

Files in your WHMCS directory should look like this.

File:DR2.png
3. When you install Domains Reseller for the first time you have to rename 'license_RENAME.php' file.

File is located at 'modules/addons/domainsRegistrar/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

File:DR3.png
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file.'

Enter your licence key between quotation marks as presented on the following screen. You can find your license key at your client area → 'My Products' .

File:DR4.png
5. Edit 'header.tpl' located at 'your_whmcs/templates/default/header.tpl' .

Add this code:

<li><a href="index.php?m=domainsReseller">Reseller Registrar Credentials</a></li><br />

After:

<li><a href="domainchecker.php">{$LANG.navwhoislookup}</a></li>
File:DR4.1.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.

File:DR5.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' .

File:DR6.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.

File:DR7.png
9. Activate and configure registrar in 'Setup' 'Products/Services' 'Domains Registrar' .
File:DR9.1.png
10. Go to 'Setup' 'Products/Services' 'Domains Pricing' .

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

File:DR9.2.png
11. To generate registrar for your resellers, make sure 'module_generator' folder have chmod set to 777.

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

File:DR7.1.png
12. Go to Domains Reseller addon, switch to 'Configuration' tab.

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

File:DR9.3.png
13. In 'Module Generator' tab enter module name into textbox and press 'Generate Module' button.
File:DR8.png
14. Downloading of module you have just generated will start shortly.

You can provide your reseller registrar module file or link to it. Link should appear right after module will be generated.
Save link and installation instruction marked on the screen below, it will not apear again.
Note: You have to provide integration code (step 5. of installation instruction) to your resellers.

File:DR9.png
15. Now you have to generate API hey for your client, go to 'API Users' tab.

Afterwards, press 'Generate API Key' next to user you want to generate API key for.
Note: API key and user email are needed as credentials in registrar module you just generated.

File:DR9.4.png
Your Domains Reseller is ready to use!

Reseller WHMCS Module Installation

Below you can find instructions for installation of the registrar module on reseller WHMCS.
1. Upload and extract registrar module into your WHMCS.
File:DR10.png
2. It's time to enter integration code you get from your provider.

Open 'additionaldomainfields.php' file located at 'includes/additionaldomainfields.php' .
Paste code you recived at end of the file, right before '?>' , as shown on the following screen.

File:DR10.1.png
3. Go to 'Setup' 'Products/Services' 'Domains Registrar' , find module you have just uploaded and press 'Activate' next to it.
File:DR11.png
4. Now, press 'Configure' button, enter 'User Email' and 'API Key' provided along with module.

Afterwards, press 'Save Changes' .

File:DR12.png
5. To continue, go to 'Setup' 'Products/Services' 'Domains Pricing' .

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

File:DR13.png
6. Afterwards, set pricing for your TLD. To do so, press 'Open Pricing' text.

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

File:DR14.png
7. Next, enter prices for specyfic actions. When you are done, press 'Save Changes' .
File:DR15.png
8. Congratulations, you have just successfully installed your registrar!

If you order domain using this registrar, you should see in your admin area something similar to the screen below.

File:DR15.1.png

Configuration and Management

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

Configuration

'Configuration' tab allows you to access general settings of your Domain Reseller API.
File:DR16.png
As you can see, you can disable API at all(1), disable API for new users(2) or autogenerate API keys for new users(3).

Note: All changes should be saved, you can do it through pressing 'Save Changes' button.

File:DR17.png
To restrict acces to Domain Reseller API by IP adress simply choose 'Enable' from 'Restrict IP' dropdown menu.

New textfield should apear, enter IP adresses you want to whitelist, one IP adress per line.
At the end, press 'Save Chanes' button.

File:DR18.png
Last, but not least thing you can do here is enabling TLD for resell.

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

File:DR19.png

API

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

Introduction

'Introduction' subtab contains information about action supported by API as well as link to it.
File:DR20.png

About

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

Examples

Here you can find examplary API request and response.
File:DR22.png

Documentation

'Documentation' subtab allows you to generate knowledgebase in your WHMCS and find link to it (if already generated).
File:DR23.png

API Users

At '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 specyfic user or group of users.

File:DR24.png
You can assign promotion code to single user(1), generate new key for him(2) or disable API for him(3).
File:DR25.png
Our module also allow performing these actions for all clients at once.
File:DR26.png

API Logs

You can display logs of request to API. As well as response to these request and information about who send request to API.

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

File:DR27.png

Module Generator

Rebranding registrar product never been easier. With our generator all you have to do is enter name for it and press 'Generate Module' .
File:DR28.png
As soon as you do that, module will be generated. Save link to it and copy installation instruction.

Note: As soon as new module is generated, integration code for it will apear as 5th step of installation instruction.
It is crucial to save it and deliver to reseller in installation instruction along with link to module.

File:DR29.png

Documentation

This tab is a hyperlink. It leads to Domains Registrar wikipedia page you are currently reading.
File:DR30.png

Email To Reseller

Email to your reseller should consist of:

♦Registrar module you generated or link to it.
♦Installation instruction (with integration code).
♦Connection credentials (user API key and email).

Provider WHMCS Client Area

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

To do so, go to 'Domains' 'Reseller Registrar Credentials'

File:DR31.png
As you can see, you can find all information linked with your registrar.

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

File:DR32.png
If your API key was exposed, generate new one through pressing 'Generate Key' .
File:DR33.png

Tips

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

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

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall is not blocking ports.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Domains Reseller For WHMCS