Reseller Central JSON API Developer Docs - WHMCS Module

WHMCS Module

The WHMCS Module allows you to setup, modify, and terminate accounts in your Reseller Central from within WHMCS.

Features

The WHMCS Module provides many fixes and ehancements over the previous Module including:

  • All locations are now available through the module including our Cloud offerings and a dynamic location option in your Module Settings.
  • IP Addresses are now properly returned to the Dedicated IP field eliminating unnecessary changes to default templates.
  • Custom Fields which provide customization of a new account and return of info including, Website Location, IP Address, and Server Name.
  • Package names provide more flexibility in ensuring what is entered in the Module Settings is the package used for the new account.
  • Built in Client Area option for updating an account's password without intervention of the reseller.

Installation

Download the WHMCS module from the Software Downloads Center in Reseller Central and follow the steps below.

  • Open the downloaded file whmcsmodule.zip and extract the resellercentral folder to a location of your choice.
  • Upload the resellercentral folder to your WHMCS installation using FTP to the /modules/servers/ folder.

Upgrading

If you are currently using an older version of the WHMCS Module please complete the steps in the Installation section of this document and complete the following steps. Overwrite the existing resellercentral folder if present.

  • Update the Module Settings tab for each Reseller Central package listed on the Setup > Products/Services > Products/Services page.
    • Ensure your API Key matches what is shown in your Reseller Centrals's Account Settings page.
    • Select a Default Location from the Location Dropdown and enter a Default Package name into the Package box.
    • If you want to assign a Skeleton Directory File for new accounts, enter the complete Skeleton filename into the Skeleton box.
  • Update your Website Location Field Option on the Custom Fields tab if configured using the string from the Location setup.

Setup

Below are the steps you will need to perform to setup the Module with your WHMCS.

Server

  • All server modules require a server, so begin by going to Setup > Products/Services > Servers
  • Click on the Add New Server link, on this page only two fields needed.
    • Name - Enter a name for the server, for example "Reseller Central" (without quotes)
    • Type - Found under the Server Details section, select "Resellercentral" in the dropdown

Package

  • Go to Setup > Products/Services > Products/Services and Click on the Create New Product link at the top of the page.
  • On the following page, enter the new name for your Package and choose the group you want to assign it to and click Submit.
  • From here you need to configure the description shown on the order form, pricing and any other details.
  • Next, go to the Modules Settings tab to configure the module settings, Select "Resellercentral" from the Server Type dropdown.
  • The required fields for the module will be displayed which include your API Key, and the default Location and Package which you wish your new WHMCS Package to use.
  • You may also enter in a Skeleton filename to use a custom Skeleton Directory for new accounts.
  • You must complete all the fields and then click Save to save the changes to the product.

Custom Fields

WHMCS provides Custom Fields as a way to display additional options for your clients during checkout and as a way for Reseller Central to provide more information such as the server name where an account is created. Custom Fields are optional and are not required to use WHMCS with Reseller Central.

Website Location

You may optionally provide your clients a Website Location option when signing up for an account. This option will be displayed on the order form and will override the default Location you have set on the Module Settings tab. You may provide all the locations or select which ones you wish to offer for the WHMCS package.

  • Go to Setup > Products/Services > Products/Services and Click the edit icon next to your Reseller Central package.
  • Select the Custom Fields tab at the top of the page and enter "Website Location" (without quotes) into the Field Name box.
  • Next in the Field Type dropdown select "Drop Down", in the Field Options box enter a comma separated list of locations.
    • (US) Central,(US) East,(US) West,(US) Cloud,(UK) Berkshire,(ASIA) Hong Kong,(ASIA) Singapore,(AU) Melbourne,(CA) Toronto,(NL) Amsterdam
  • Lastly tick the checkbox for Show on Order Form, save your changes and thats it!

Server Name

You may wish to know the name of the server where an account is created that can be used on a Welcome Email.

  • Go to Setup > Products/Services > Products/Services and Click the edit icon next to your Reseller Central package.
  • Select the Custom Fields tab at the top of the page and enter "Server Name" (without quotes) into the Field Name box.
  • Lastly ensure the checkbox for Show on Order Form is not checked, save your changes and thats it!

IP Address (legacy)

Previous versions of the Reseller Central WHMCS module provided the IP Address of an account through this custom field. The current module now places the IP Address in the Dedicated IP field within WHMCS. If setup this field will also contain the IP Address of a newly created account to accomodate legacy templates setup with the previous module.

  • Go to Setup > Products/Services > Products/Services and Click the edit icon next to your Reseller Central package.
  • Select the Custom Fields tab at the top of the page and enter "IP Address" (without quotes) into the Field Name box.
  • Lastly ensure the checkbox for Show on Order Form is not checked, save your changes and thats it!

Change Log

Below are changes and/or fixes made to the Reseller Central WHMCS module

  • 2012-09-03 - v2.3 - Added the ability to assign Skeleton Directory filenames to products.
  • 2012-08-20 - v2.2 - Added Change Password option to Client Area.
  • 2012-08-15 - v2.1 - Added Server Name and IP Address custom fields.
  • 2012-08-10 - v2.0 - Initial release of version 2.0 module using JSON API.