As a provider, you are able to handle all details of your reseller groups and set up pricing rates for each product in a particular group effortlessly.
Moreover, your resellers grant all crucial information about placed orders along with API documentation. As for end clients, they are able to buy preferred products and perform basic actions on them later.

In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.
If you need a package for the previous versions of PHP, please contact our support.

The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

The content of the chosen PHP version files to upload should look like this.

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

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'.

This folder is available at 'yourWHMCS/modules/addons/products_reseller/'.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules'. Afterwards, find 'Products Reseller' and press the 'Activate' button.

To do so click on 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

You can access your module at 'Addons' → 'Products Reseller'.

Here you may set up general options but still, you will be able to change them per single group. If you skip group settings, these configuration will be taken into account.

Global API related section:

• 'API Status ' - enable/disable Domains Reseller API.
  
• 'IP Addresses Restriction' - enable/disable restricting connection to Products Reseller API only for IP addresses specified in the 'Allowed IP Addresses' field.
  
• 'API Requests Restriction' - enable option to restrict the number of API requests.
  

• 'Low Credit Notification' - a notification to your client will be sent when credit balance on client's account falls below entered value.
  You may view and edit the "Low Credit Notification" custom email template sent to clients at 'WHMCS' → 'Setup' → 'Email Templates'. This email message is sent with the main WHMCS cron job.

• 'Low Credit Amount' - amount of credits, when reached a notification will be sent.
  

• 'Payment Type' options:
  • 'Pay After Registration' - resellers must have sufficient credits amount, but he is charged only after a domain has been successfully registered.
  • 'Pay After Order' - resellers must settle the payment just after the order, the amount due is taken from his account instantly.
    

• 'Refund Type' - defines behavior of the module upon unsuccessful domain registration.
  
  • 'Credits Only' - if selected, refunds are granted in form of credits only.
  • 'Refund Invoice' - if selected, refunds are delivered in form of credits along with a newly generated invoice.
  • 'Disabled' - if selected, refunds are not accepted.

Remember to submit the changes, once you have finished.

• 'API Status' - enable/disable Products Reseller API for Resellers assigned to this very group only
  
• 'IP Address Restriction' - enable/disable restricting connection to Products Reseller API only for IP addresses specified in the 'Allowed IP Addresses' field.
• 'API Requests Restriction' - enable option to restrict the number of API requests.
• 'Show API Documentation' - toggle to allow resellers access to API documentation directly from their Reseller Area.
• 'Low Credit Notification' - turn on sending notifications to your client when credit balance on client's account falls below entered value.
  You may view and edit the "Low Credit Notification" custom email template sent to clients at 'WHMCS' → 'Setup' → 'Email Templates'. This email message is sent with the main WHMCS cron job.
• 'Low Credit Amount' - amount of credits, when reached a notification will be sent
• 'Payment Type' options:
  • 'Pay After Registration' - resellers must have sufficient credits amount, but he is charged only after a domain has been successfully registered.
  • 'Pay After Order' - resellers must settle the payment just after the order, the amount due is taken from his account instantly.
• 'Refund Type' - defines behavior of the module upon unsuccessful domain registration.
  • 'Credits Only' - if selected, refunds are granted in form of credits only
  • 'Refund Invoice' - if selected, refunds are delivered with in form of credits only
  • 'Disabled' - if selected, refunds are not accepted

Save the changes when ready.

Press 'Add Integration' to begin.

• Enter your module unique name

• Type in a short description of the module, it will be visible on the activation page of the registrar

• Upload file with documentation if you have prepared any - you may use any format.

1. Edit its details (change name, description, or file) at any time
2. Download the integration package
3. Delete the integration

Press 'Assign Product' button to begin.

• Settings
• Set Pricing
• Unassign Product

• Select one of your previously created groups, to which the reseller should be assigned.

• Then select one of your clients from the dropdown, start typing to see a list of clients

• Generate an API Key for the Reseller, it will be necessary when configuring the integration module with the Reseller's platform

• Prepare a list of allowed IP addresses, use comma or a space to separate - note that this option must have been enabled previously in the module general settings here

• API Status - toggle to allow reseller generate the API key in the Reseller area

• API Limits - toggle to be able to define precise limits
  • API Interval [Min] - enter a time interval in minutes in which a provided below number of API requests can be called
  • API Requests Limit - maximum number of API requests in the time interval

Apart from them, you may preview the API Email Address and API Key required to activate and configure the integration module.

In order to add a new response template press 'Crate Template' button and then follow the below instructions.

• For Text type, simply provide a string like 'Error Response'.
  
• For Regular Expression type, you need to provide a regular expression which will be replaced.
  For example, if you want to replace any dollar price in the response provide '\$\d+\.\d+', in this case it will replace strings like '$8.25'.
  
• If you want to replace any response, simply type '.+' in here.

• choose 'Text' or 'Regular Expression' from Type dropdown menu.
  

It will specify if provided text in the first field should be treated as a text or a regular expression while searching for a pattern.

• Registrar Action - must be chosen from dropdown menu as well to specify upon which action provided patterns will be searched for.

Remember, to finish successfully you need to press 'Confirm' button.

This API documentation has been prepared to allow you to write your own integration modules for platforms other than WHMCS.

'Information' subtab contains:

• Endpoint - URL to which all the API requests are directed

• Authorization - Username and token parameters to authenticate the client in the API request

• Example - exemplary request to API to renew a domain

Note: The screen below does not capture all the supported functions.
Full API functionality can be found on the module features list at the top of this documentation.

Go to 'Services' → 'Reseller Area' to access them.

This API documentation has been prepared to allow you to write your own integration modules for platforms other than WHMCS.

'Information' tab contains:

• Endpoint - URL to which all the API requests are directed

• Authorization - Username and token parameters to authenticate the client in the API request

• Example - exemplary request to API to renew a domain

Note: The screen below does not capture all the supported functions.

Please refer to section Integrations to learn how to generate an integration module for your resellers.

Once you have uploaded the integration module, you should find a new folder with this module in 'resellerWHMCS/modules/servers/' directory as presented below.
Important: The folder and module name as well as description of the extracted integration module is customized by the provider and will be different that the one presented in the example below.

To create a product, click on 'Create a New Product'.

In a basic workflow 3 users take part:
Provider – a person with Products Reseller For WHMCS installed on the WHMCS system.
Reseller - a provider's client who aims at reselling products offered to him by the provider.
The reseller must own a system with integration module generated for him by the provider with Products Reseller For WHMCS.
End Client – a person with a client account in the Reseller's WHMCS.

Provider's Part
Let us start from the beginning. Provider installs Products Reseller For WHMCS in the system.
He already has some products in the offer and wishes to allow the reseller to resell them.
Now, the provider configures Products Reseller For WHMCS, creates groups, configures them and assigns products and defines their pricing for the reseller who is assigned to one of the groups.
Finally, selects which of the clients will become resellers, assigns them to previously created groups and generates access details.

Reseller Part
The Reseller has access to the Reseller Area once logged into the provider's client area.
There, he can download both the integration module and its documentation as well as generate and copy any API details required to activate the integration module in his own system.
Then, the reseller needs to set up products that the provider allows him to resell with the integration module delivered by the provider. Defines the pricing (prices must be higher than the ones the provider has set up to generate any income).
There is one step that separates the reseller from offering the domain from his system.
The reseller must add funds to his credit balance in the provider system to be able to pay off the charges and settle the amounts owed to the provider for his resold products .
Provider creates an 'add funds invoice' for the Reseller, the Reseller pays the invoice and then again the Provider adds the same amount to Reseller's credit balance.
From now on, any domain can be ordered.

End Client
End Client orders a domain from his client area in the Reseller's system.

Last Word About Payment
Now, that the End-Client has ordered and paid the reseller for the domain, at the provider's system a new invoice for that domain is created automatically (on behalf of the reseller).
Depending on the selected "Payment Type" configuration the invoice will be paid with credits and domain attempted to be registered or attempt to register the domain and if successful, the invoice will be paid with credits.
In case the reseller does not have sufficient credits on his account to pay for the domain registration the process is stopped until the invoice is manually paid by the reseller.
The reseller's income is the difference between the price of the sold domain to the End-Client and the price he paid to the provider.

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!
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.