ResellerTown - Domain Reseller -Documentation Print

  • reseller, domain, domain reseller, reseller module
  • 0

Reseller Area

Resellers can manage API connection credentials directly from the provider WHMCS client area as well as see any details on its TLDs offer.

Go to ‘Domain Reseller' to access them.

 

 

Orders

As you can see, 'Orders' section includes a detailed list of orders placed on domains with offered TLDs, with any payment details and date.

 

 

Pricing

'Pricing' section includes a list of the Reseller's TLDs with the option to preview its pricing set up by the provider.

 

 

 

 

Domains

The 'Domains' section allows Resellers to manage their domains.
If you want to assign any domains that were bought previously, simply click on the following button.

 

 

 

Now you can select one or more domains from the dropdown menu.

 

 

 

There is also the possibility to unassign the particular domain.
Note: Please remember that once a domain is unassigned, you are not able to manage it until it is assigned again.

 

 

Settings

Under 'Settings' section you will find any API details necessary to install and activate the integration module.

 

 

 

Underneath the API details you will find a list of generated integrations.
Depending on the provider, you may download the packages, download the additional fields and documentation per Integration.

 

 

Logs

Preview a list of logs on API requests and responses, including errors stored in the module.

 

 

API Documentation

Access API documentation details with basic information and API Calls and Models.

This API documentation has been prepared to allow you to write your own integration modules for platforms other that WHMCS and Blesta (included by default).

'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

 

 

 

Available 'Calls' list:

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

 

 

 

Available 'API Models' list:

 

 

Domains Reselling Workflow

Installation Of Integration Module

Below you can find instructions for installation of the integration module on the reseller's WHMCS.

 

An exemplary flow of installation and configuration of the integration module to resell TLDs on Blesta, can be found in Blesta official documentation.

 

1. Upload and extract the registrar module into your WHMCS.

Once you have extracted the module, you should find a new folder with the registrar in 'resellerWHMCS/modules/registrars/' directory.
Important: The folder and module name, logo and description of the extracted integration module is customized by the provider and will be different than the one presented in the example below.

 

 

 

2. Go to 'System Settings' → 'Domains Registrars' , find the module you have just uploaded and press 'Activate' next to it.

 

 

 

3. Now, press 'Configure' button, enter 'User Email' and 'API Key' provided along with the module.

You can find these data in your Reseller Area in the Provider's Client Area. Afterwards, press 'Save Changes'.

 

 

 

5. To continue, go to 'System Settings' → 'Domains Pricing'.

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

 

 

 

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

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

 

 

 

7. Next, enter prices for specific actions. Press 'Save Changes' to confirm.

 

 

 

8. Congratulations, you have just successfully installed your registrar!

 

 

Sample Workflow

In this section we will present to you a sample workflow of the module.

In a basic workflow 3 users take part:
Provider (ResellerTown) – a company  with Domains Reseller For WHMCS installed on the WHMCS system.
Reseller (You) - a provider's client who aims at reselling TLDs offered to him by the provider.
The reseller must own a system with integration module generated for him by the provider with Domains Reseller For WHMCS.
End Client (Your client)– a person with a client account in the Reseller's system (WHMCS, Blesta or others).

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

 


Was this answer helpful?

« Back