Integration between ISPmanager and WHMCS

From ISPWiki
Jump to: navigation, search

Features

There are two integration modules with WHMCS:

  • ISPmanager
  • ISPmanager Reseller

The module supports the following General features :

  • Creates a user in ISPmanager
  • Enables/disables users
  • Deletes users
  • Allows to log in to control panel as User or Admin
  • Changes tariff plans

Notes:

  • ISPmanager Reseller can be used for "Reseller Account" services. Integration should be performed with admin permissions (ISPmanager)
  • ISPmanager can be used for "Hosting Account" services. Integration should be performed with both admin and reseller permissions

Installing integration modules

To install the integration module, go to the modules directory in the WHMCS installation's root directory, download and unpack the file:

WHMCS v7.x

http://download.ispsystem.com/extras/whmcs/7/whmcs_isp_isp.tar.gz - archive for  ISPmanager

Earlier versions

http://download.ispsystem.com/extras/whmcs/whmcs_isp_isp.tar.gz - archive for  ISPmanager (it doesn't include the  ispmanager_reseller module)

After installing the modules, go to "Setup -> Addon Modules" and click "Activate" for the "ISPsystem global module". Once you are done, you can proceed with configuring your tariff plans and servers.

Connecting to the server with ISPmanager

Navigate to "Setup -> Products/Services -> Servers" ->"Add New Server" (we recommend grouping the servers).

Complete the steps below:

  • Choose the corresponding server type: ISPmanager/ISPmanager Reseller
  • Enter ISPmanager URL
  • Enter user or admin's login and password to the control panel (enter admin's login and password if you selected ISPmanager Reseller).

Сonnect to the server on port 1500 through HTTPS using the IP address specified in the server edit form. For each server, the "Go to server" button will be available enabling to get authorized with a temporary key.

Configuring a tariff plan

When adding a tariff plan you can enter the following parameters:

  • Product Type - Hosting Account
  • Product Group - product group
  • Product Name - tariff name

In the "Module Settings" tab you can select:

  • Module Name - ISPmanager or ISPmanager Reseller
  • Server Group - group of corresponding servers

Provide parameters that will be used for user creation in ISPmanager

  • Package Name - name of the existing user template in ISPmanager. You can find it in the "Templates" module
  • Traffic quota - traffic limit
  • Db user count - number of database users
  • Web domains count - number of web-domains
  • Email box count - number of mailboxes
  • Memory limit - RAM limit
  • Email box quota - mailbox disk quota limit
  • Disk quota - disk quota limit
  • Db count - number of databases
  • FTP user count - number of FTP users
  • Email domains count - number of domain names
  • CPU time - cpu usage limit
  • Processes count limit - limit on the number of running processes
  • Main IP address type - type IP address
  • Username template - if not specified, the username generated in WHMCS will be used.


If a parameter is not specified, the value will be taken from the corresponding user template.

You can also provide additional options, such as IPv4 and IPv6 addresses. Go to the "Configurable Options" module, create a new group of options (we recommend creating a separate group of options for each server; or make sure the list of disk templates is suitable for all servers) and create required options. The option name for IPv4 is IP, for IPv6 - IPv6. This feature is available only when you are integrating with ISPmanager Business. In ISPmanager Lite you cannot allocate an IP address to a user.

You can allow your client to order multiple IP addresses.