Resellers Center For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

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.

  • Provider Features:
✔ Define Global Configuration And Reseller Permissions
✔ Manage Assignment Of Clients To Resellers
✔ Create And Manage Pricing Groups
✔ Assign Clients to Pricing Groups To Set Them As Resellers
✔ Assign Products, Addons And Domains To Pricing Groups
✔ Define Pricing Range Per Products, Addons And Domains For Each Billing Cycle
✔ Select Payouts Calculation Method Per Products, Addons And Domains:
✔ Fixed Rate
✔ Difference
✔ Percent Rate
✔ Percent From Difference Between Admin And Reseller Price
✔ Admin Percent With Fixed Rate
✔ Reseller Percent With Fixed Rate
✔ Write Own Class To Calculate Reseller Profit
✔ View Statistics On Resellers Sales, Income And End Clients
✔ View Reseller Profits
✔ Enable Reseller Own CNAME Domain Support
✔ Select Available Store And Order Templates
✔ Choose Email Templates Available For Branding
✔ Choose Payment Gateways Available For End Clients
✔ Choose Ticket Departments Available For End Clients
✔ Determine Invoicing Method For Billing End Clients:
✔ Provider As Issuer Of Invoices
✔ Reseller As Issuer Of Invoices
✔ Allow Invoice Branding
✔ Define Default Sequential Invoice Number Format
✔ Make Payouts To PayPal Account Or Credit Balance
✔ Enable Automatic PayPal Payout Transfers
✔ Prepare Documentation For Each Reseller
✔ Access To Module Logs
  • Resellers Features:
✔ Configure Reseller Brand:
✔ Domain
✔ Company Name
✔ Store Logo
✔ Invoice Pay To Text
✔ Sequential Invoice Number Format
✔ Tickets Email Signature
✔ Store And Order Template
✔ Available Ticket Departments
✔ Set Up Indepenent Payment Gateways Available For End Clients:
✔ Bank Transfer
✔ PayPal
✔ Stripe
✔ Define Order Of Payment Gateways
✔ Define Prices Of Products, Addons And Domains Within Defined Limits
✔ Add And Manage End Clients
✔ View End Clients Orders, Invoices, Products, Addons And Domains
✔ Place Orders For End Clients Manually
✔ Manually Accept Order Of End Client Before Payment Receipt
✔ Login As End Client
✔ View Statistics On Sales, Income And End Clients
✔ View Generated Profits
✔ Access Documentation
✔ Receive Payouts To PayPal Account Or Credit Balance
✔ Receive Email Notifications On End Clients Orders
✔ Reply To Tickets Submitted By End Clients
✔ View Email Templates And Use Editor To Modify Their Content
✔ Access Store By CNAME Domain Or Default Store URL
  • End Clients Features:
✔ Order Products, Addons And Domains
✔ Use End Client Details For Registered Domains
✔ View And Pay Invoices
✔ Pay Using Credit Card And Store Payment Data
✔ View And Manage Products
✔ Receive Branded Email Notifications
✔ Submit Tickets To Reseller
  • General Info:
✔ Migration Tool
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7
✔ Supports WHMCS Template Six
✔ Supports WHMCS 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 the module.
R3 1 new.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6, while the second one is aimed at PHP 7.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

R3 2.png
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.

The content of PHP version files should look like this.

R3 2 1.png
4. When you install Resellers Center For WHMCS 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
5. In order to configure your license key you have to edit a previously renamed 'license.php' file.

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

R 4.png
6. 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

7. 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 new.png
8. 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 new.png
9. Afterwards, go to 'Addons' 'Resellers Center' 'Integration Code' and follow the instructions.
R3 10.png
10. 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 - Allows 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.
  • Default Reseller Documentation - Select default documentation to show for new resellers.
  • 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 automatic transfers to reseller's account.
  • Invoice Branding - If enabled, resellers can brand the number and basic information on the invoice.
  • Reseller Invoice - If enabled, resellers can issue invoices for end clients directly (otherwise, invoices are generated by the administrator).
    This option also permits resellers to use their own configuration data in payment gateways settings (currently, 'PayPal', 'Stripe' and 'Bank Transfer' gateways are available).
    Once they do it, end clients are able to make payments directly to the reseller's account and the reseller settles debts with the administrator using prepaid WHMCS credits.
  • Sequential Invoice Number Format - Required if 'Reseller Invoice' is enabled.
  • Gateways - Allows you to select gateways that resellers can enable in their own stores. This option is only available if 'Reseller Invoice' is disabled.
R3 11 1 new.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 new.png

Migration Tool

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

Note: Version 3.x currently supports migration from version 2.5.x module and it will only transfer data on resellers, resellers' clients and resellers' groups.
Therefore, the other settings of the module need to be reconfigured manually.

To perform the migration simply overwrite old files to the latest version of the module and refresh the addon page in the admin area.


Addon Management

In this section you can find more details about the management possibilities.

We will show you how to set up key options to ease the module's handling processes.

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 is visible 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. Then, 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 a 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 a product
  • Lowest Price - minimum price which can be set for a 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 the right button, as shown below.
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.

You can use it to assign any client to a reseller's group, that will activate them as resellers.
Click the button as shown below to create a new reseller.

R3 19.png
Assign the new reseller to the chosen group.
R3 19 1.png

Clients

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

Apart from clients, you can manage here also invoices, transactions and services.

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 the list of all resellers' transactions and make profit payouts to them. Moreover, you can accept 'Mass Payments' for selected resellers here.

Please note - this tab is only used if the 'Reseller Invoice' configuration is set to 'Disabled'.
Otherwise, the resellers settle debts with the administrator using prepaid WHMCS credits and payments made by end clients are credited to the reseller's account directly.

R3 41 2.png

In 'Payouts' section, apart from looking at the details it is also possible to perform the following actions: pay by PayPal (1) or WHMCS Credits (2) and mark the transaction as completed (3).
'Mass Payments' section enables you to make mass payouts to all selected resellers at once. You can choose from PayPal Payment (4), WHMCS Credits Payment (5) and set up proper
PayPal Configuration (6) by providing PayPal Application Key and Secret - both found within your PayPal account.

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 'Integration Code' tab you will find the instructions on how to allow your resellers to modify client area and invoice logo.
R3 44.png

Reseller Documentation

The 'Reseller Documentation' tab enables you to create and modify documentation visible to specified resellers. The documentation provides guidelines to help resellers handle their panels with ease.
You can create documentation in multiple versions - to add a new one, simply click the '+' button. Press the appropriate button located at the 'Actions' column to manage already formed documentation:

R3 44 2.png

Choose the resellers to whom the documentation will be visible, enter the name of the documentation and its content.
You can use HTML tags as well as attach a PDF version of your documentation.
Once ready, click 'Save' to save your documentation.

R3 44 3.png

From now on, our resellers will be encouraged to read the documentation from the welcome page, when they enter the Reseller Area for the first time.
Reseller can hide the welcome page by pressing "Do not show again". Even then, the documentation is accessible from the menu:

R3 44 4.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, to whom reseller's groups are assigned 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 a client (1), make an order for a client (2), view client's details (3) and delete a 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 clients.

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 clients.
You can also get here a direct cart URL to products group that you can share directly with your customers.

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 client's client area, emails and invoices.

Please note, that the available reseller configuration options may vary depending on the options you selected in the addon configuration and whether the 'Reseller Invoice' option was enabled for the reseller.

  • For example: if 'Reseller Invoice' is disabled there will be an option to provide reseller PayPal email but reseller will not be able to configure available payment gateways on their own:
R3 30 new.png
  • However if 'Reseller Invoice' is enabled there will be an option to configure payment gateways by reseller or enable auto WHMCS invoice payments.
R3 30 0.png
'Email Templates' is the place where you can view and edit email templates sent to your clients.

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

R3 30 1 new.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
'Payment Gateways' - this tab is only available if the 'Reseller Invoice' option in the admin area is set to 'Enabled'.

In this section, the reseller can set up their own payment gateway ('PayPal', 'Stripe' and 'Bank Transfer' gateways are currently available).
Thanks to this, all payments made by end clients are transferred directly to the reseller's PayPal account or bank institution.
The payments between the reseller and the administrator are settled through the reseller's previously supplied credit balance.

R3 30 3.png

Invoices

Here is the detailed list of end clients' all invoices together with their status.
  • If the 'Reseller Invoice' option in the admin area is 'Disabled', the listed invoices are generated between the end client and the site administrator.
  • If the 'Reseller Invoice' option in the admin area is 'Enabled', the listed invoices are issued between the end client and the reseller directly.
R3 46 new.png
Using 'Action' button on invoices list reseller can also view and manage the invoice details, similarly to how it is done in the admin area.
R3 46 2.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 two ways to add a product to an end client account, we will show you both of them below.

Assign Product by Reseller

Your resellers can place orders for their own customers as if the orders were for themselves.
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 clients can view order form with the list of products configured by their resellers.

Therefore, your reseller's clients can make orders on their own, 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 clients.

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 list of all the tickets created by a reseller's clients from the client area.
R3 39.png
You can easily reply to them.
R3 39 1.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 resellers.
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.

3. When it comes to our Resellers Center For WHMCS and Social Media Login For WHMCS modules, they are compatible and work faultlessly unless your reseller uses branded domain.

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.
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
Resellers Center For WHMCS