Personal tools
Namespaces

Variants
Actions

Resellers Center For WHMCS

From ModulesGarden Wiki
Revision as of 19:15, 22 March 2017 by Katarzyna.pa (Talk | contribs)

Jump to: navigation, search

Article update is ongoing on this page, watch out for broken links and unclear descriptions!
We are sorry for the inconvenience caused.


Contents

About Resellers Center For WHMCS

Resellers Center For WHMCS gives your resellers the possibility to manage end-clients and their orders through WHMCS!

With this module, your resellers will be allowed to acquire their own customers and assign products, services and domains to them.
Thanks to that, end-clients will be able to easily order services directly from your WHMCS.
Moreover, they will be able to log in to their own WHMCS account in order to manage their services, pay invoices or even create tickets.

  • General Features:
✔ Define Global Configuration And Reseller Permissions
✔ Define Email Templates Available For Rebranding
✔ Define Ticket Department Available For End-Clients
✔ Create & Manage Reseller Groups
✔ Assign Products To Reseller Groups
✔ Define Price Limits And Profit Counting Per Product
✔ Allow Clients To Start Reselling Through Assigning Them To Reseller Groups
✔ Define Domains Discount Per Reseller
✔ View End-Clients As Contacts And Manage Assignment Of Their Products And Domains
✔ View Reseller Profit Earned From Each End-Client Order
✔ VIES Based EU VAT Removal For End-Clients
✔ Define Resellers Branding Permissions
  • Resellers Features:
✔ Create And Manage End-Clients As Contacts
✔ Define Permissions Of End-Clients
✔ Create End-Client Account During Order Creation
✔ Order Products On Behalf Of End-Clients
✔ View Current Balance, Total Profit Made And Credit Balance
✔ Redeem Credit Balance From Current Balance
✔ View Profit Generated By Each Transaction Made By End-Clients
✔ Define Prices Per Product Within Defined Limits
✔ Configure Reseller Brand - Domain, Company Name, Email Signature And Logo
✔ Domain
✔ Company Name
✔ Email Address
✔ Email Signature
✔ Email CSS Schema
✔ Logo
✔ Access Branded Order Links - CNAME Record Is Required
✔ View Email Templates And Modify Them Using Improved Email Templates Editor
✔ Reply To Tickets Of End-Clients
  • End-Client (Contact) Features:
✔ Order Products/Domains
✔ View And Pay Invoices
✔ View And Manage Products
✔ Receive Branded Email Templates
✔ Open And Manage Tickets
✔ Use End-Client Details For Registered Domains
  • General Info:
✔ Migration Tool
✔ Multi-Language Support
✔ Supports PHP 5.3 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation

Installation of Resellers Center For WHMCS requires a few simple modifications of the template files.

No worries, we will guide you step by step through the entire installation process.

Note: If you are still using any of Resellers Center For WHMCS previous versions prior to v3.x, read about it here.

Installation

1. Log in to your client area and download Resellers Center For WHMCS Module.
R 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like these.

R 2.png
3. When you install Resellers Center module for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/ResellersCenter/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

R 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 in your client area → 'My Products'.

R 4.png
5. The next step is setting up 'storage' folder as writable.

It is located in 'your_whmcs/modules/addons/ResellersCenter/'.

R 5.png

Activation Of Addon

6. Now, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Click 'Setup' then choose 'Addon Modules'.
Afterwards, find 'Resellers Center' and press 'Activate' button.

R3 6.png
7. In the next step, you need to permit access to the module.

To do so, select admin roles which should have access to the module and press 'Save Changes'.

R3 7.png
8. Afterwards, go to 'Addons' 'Resellers Center' 'Integration Code' and follow the instructions.
R3 10.png
9. You have just successfully installed Resellers Center For WHMCS!

Management and Configuration

Management of Resellers Center For WHMCS is very convenient. You can supervise everything from the addon.

What is more, the module extends possibilities of both your resellers and their customers.
Let us find out what our product can do.

Settings

In this section you can find more information about global configuration.

Additionally, here you can also read about the details of migration.

Configuration

In 'Configuration' tab you can set up global settings of the module. You can define 'General', 'Billing' and 'Email Templates' settings.

Please note that these settings are default for all resellers. Read this section through to find the details of configuration per each reseller.

General Settings

  • Enable Store Branding - Allowing resellers to set up custom logo, company name and domain.
  • Allow Products - If enabled, resellers will be able to sell properly configured products in their own stores.
  • Allow Domains - Gives resellers possibility to sell domains in their own stores.
  • Allow CNAME - It enables support for CNAME record pointing from customer domain.
  • Ticket Departments - Allows you to choose ticket departments available for end clients as they will contact resellers.
  • Templates - Allows you to select client area templates of resellers store.
  • Order Templates - Allows you to select order templates set for cart view in resellers store.
R3 11.png

Billing Settings

  • PayPal Auto Transfer - Enables transfers to reseller account.
  • Invoice Branding - If enabled, resellers can brand the number and basic information about an invoice.
  • Sequential Invoice Number Format - Required if 'Reseller Invoice' is enabled.
  • Gateways - Allows you to select gateways that resellers can enable in their own stores.
R3 11 1.png

Email Templates Settings

Here you can enable/disable numerous options that a reseller can customize later on.
These templates are related to emails regarding issues like:
  • General
  • Product
  • Domain
  • Support
  • Invoice
R3 11 2.png
Each setting can be defined for particular resellers. Go to 'Resellers' tab and press the button.
R3 11 3.png
Here you will find the details related to the chosen reseller. In 'Configuration' section you can select preferred 'General', 'Billing' and 'Email Template' settings.
R3 11 4.png

Migration Tool

Migration tool allows you to upgrade Resellers Center For WHMCS module to the latest version.

Note: Version 3.0.0 is currently in beta and it does not support migration from version 2.x. Therefore, the module needs to be reconfigured.
The migration will be available upon the next release.


Addon Management

In this section you can find more information about management.

We will show you how set up key option to ease the work with our module.

Pricing Groups

In order to grant any of your clients resellers' rights, you need to configure a group first.

To do so, proceed to 'Pricing Groups' tab and click the button as shown below.

R3 14.png
A popup window appears. Just fill in a group name and press 'Create'.
R3 14 1.png
As you can see, a new group appears on the list. It does not have any product configured.

To add a new product press the button as presented below.

R3 15.png
Choose a new product from 'Add Product To Group' dropdown menu and press 'Save'.
R3 16.png
The product needs to be configured and Resellers Center For WHMCS enables you to:
  • Edit Pricing (1)
  • Edit Calculation Method (2)
  • Delete Product (3)
R3 16 1.png

Product Pricing

It is possible to set pricing (1) for different billing cycles and currencies.

You can define pricing using the below options:

  • Admin Price - price set for product (it may be lower than what reseller sets when this difference will be the basis to calculate profit)
  • Highest Price - maximum price which can be set for product
  • Lowest Price - minimum price which can be set for product

To confirm settings press 'Save' .

R3 17.png

Calculation Method

Several methods for calculation (2) are available. Choose the one you want to use from dropdown menu.
  • Fixed Rate - profit that your reseller always gets
  • Difference - between reseller's and admin's price
  • Percent Rate - percentage of reseller's price
  • Percent From Difference - a sum of reseller's price percentage and a difference between reseller's and admin's price
  • Admin Percent With Fixed Rate - a sum of admin's price percentage and a fixed rate
  • Reseller Percent With Fixed Rate - a sum of reseller's price percentage and a fixed rate


  • Percent Rate - (if calculation method uses it) percentage amount granted to reseller for selling this product
  • Fixed Rate - (if calculation method uses it) fixed amount granted to reseller for selling this product

To confirm settings press 'Save' next to the product you have configured

R3 17 1.png
The procedure is quite similar when it comes to adding addons and domains.

Click a right button to add a new addon.

R3 17 2.png
From dropdown menu choose the one that will be added to the group.
R3 17 2 1.png
Now you can set 'Pricing' and 'Calculation Method' or delete this addon.
R3 17 3.png
In order to add a new domain click a right button as shown.
R3 17 4.png
From dropdown menu choose the one that will be added to the group.
R3 17 4 1.png
Now you can set 'Pricing' and 'Calculation Method' or delete this domain.
R3 17 5.png


Resellers

'Resellers' tab displays all clients from your WHMCS system.

From here you can assign any of them to a reseller's group, which activates them as resellers.
Click a button as shown below to create a new one.

R3 19.png
Create a new reseller and assign him to the chosen group.
R3 19 1.png

Contacts

To see resellers' contacts go 'Resellers' tab and click the button next to selected reseller.
R3 11 3.png
Here you can obtain more details about your customers and their clients.

Apart from clients also invoices, transactions and services can be managed from here.

R3 11 4 1.png
You can also assign a new client to this reseller.
R3 11 4 2.png


Payouts

In 'Payouts' tab, you can view a list of all transactions made by resellers. From here it is also possible to accept 'Mass Payments' of selected resellers.
R3 42.png

Statistics

'Statistics' tab allows you to see the amount of sales and income, and the number of clients assigned to resellers.
R3 18 1.png
Information about sale is also visible in the 'Reseller' tab.
R3 18.png

Logs

'Logs' tab allows you to see the details of the actions that have been already performed.
R3 43.png

Integration Code

In the last 'Integration Code' tab you will find the instructions on how to allow your resellers to modify client area and invoice logo.
R3 44.png

Client Area - Reseller

In the client area your can add new subclients and access Reseller Area.

Access to the Reseller Area is granted only to those clients, whom reseller's groups are assigned to in Resellers Center For WHMCS module.

R3 25.png

Reseller Area

In Reseller Area you can manage clients, define products prices, set up branding, customize email templates and open tickets.

Clients

Under this tab, you can see a list of reseller's clients and perform various actions.

It is possible to log in as client (1), make order for client (2), view client's details (3) and delete this client (4).

R3 45.png
To add a new client, press the button as presented below.
R3 45 2.png
Fill in all the necessary details in both 'General' and 'Address' sections.

Remember to save changes.

R3 45 2 1.png
When you enter client's details view (3), you will find here not only his personal details but also information about orders, invoices, services, addons and domains.
R3 45 1.png

Product Pricing

'Product Pricing' tab enables you to define prices for products, addons and domains you wish to offer to your contacts.

Remember, you can define prices only within limits shown as placeholders.
If pricing is not provided, product, addon or domain will not be available for your contacts.

R3 29.png

Configuration

In 'Configuration' tab you are allowed to define 'General Settings' such as your own company name, email signature and logo used across contact's client area, emails and invoices.
R3 30.png
'Email Templates' is the place where you can view and edit email templates sent to your contacts.

To edit an email template, press 'Edit' button next to the template you wish to alter.

R3 30 1.png
Finally, edit the email template to suit your needs and press 'Save Changes' button.

Note: During this step you can easily add merge fields using dropdown menus marked on the following screen.

R3 30 2.png

Invoices

Here is the detailed list of clients' all invoices together with their status.
R3 46.png

Orders

This section allows you to view all of the orders with their chosen payment method and status.
R3 31.png

Ordering

There are three ways to add a product to an end client account, we will show you all of them below.

Assign Product by Reseller

Your resellers can place orders for their own customers as if the orders were for themselves.

The only difference is that they need to choose a contact from 'Subclient' dropdown menu. And that is all!

R3 34.png
Both your reseller and the end client will receive an order confirmation email.

Afterwards, when end client logs in to the WHMCS client area, he/she will be able to view and manage previously ordered products.
End clients can also list and pay invoices or create tickets (if these options are checked in the addon module).

R3 35.png

Access Order From The Client Area

Your reseller's contacts can view order form with the list of products configured by their resellers.

Therefore your reseller's contacts can make orders on their own through using order forms in the client area.

R3 37.png

Tickets Management

If you have not disabled tickets in your addon, your resellers will be able to reply and forward tickets created by their contacts.

It is only available for tickets department set in Resellers Center For WHMCS configuration.

R3 38.png
On the screen below you can see a ticket created by a reseller's contact from the client area.
R3 39.png

Client Area - End Client

End client sees branded client area.

Since version 3.x of the module end clients are treated as regular WHMCS clients.

R3 40.png

General Relations

Relations between Provider, Reseller and Client
Payment system:

In general Reseller receives a product from the Provider and then provides it further to the End Client.
Since the release of v3.0.0 the payment between the Reseller and Provider will be regulated by WHMCS credits but it can be also regulated manually or automatically to Reseller's PayPal account.

Tips

1. You can create a hidden product group visible only for your resellers and their clients.

To do so, create hidden product groups containing products available for resell.
Afterwards, just assign the product group to the client group in your Resellers Center addon → 'Configuration' tab (assignment is shown on the 2nd screen of this section).

2. If your WHMCS is installed in a subdirectory, your resellers using CNAME record must provide their links with it.

For example, reseller.com/main-whmcs-directory instead of reseller.com..
You can change that behaviour through adding the below code to .htaccess file:

RewriteEngine on
RewriteCond %{HTTP_HOST} !^main-whmcs-domain.com$ [NC]
RewriteCond %{REQUEST_URI} !^/whmcs-directory/
RewriteRule ^(.*)$ /whmcs-directory/$1 [R=301,L]

Result: If hostname is not main-whmcs-domain.com and path is not whmcs-directory', then redirect to resellers domain with /whmcs-directory.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. When you use https on main WHMCS and your reseller passes non-https domain, the end client will see a warning message from browser that the certificates do not match.
3. Resellers Center For WHMCS is not fully compatible with our Multibrand For WHMCS module.

If you have Multibrand installed on you system as well, you may encounter some issues connected with configuring domains.

4. Please remember that Resellers Center For WHMCS works flawlessly with WHMCS V6 and V7 along with the officially supported Template 'Six'
In case you are using some custom template, you must be aware that unexpected errors might occur and we cannot take the responsibility for solving them.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Resellers Center For WHMCS