Skip to main content

OpenPanel and WHMCS

OpenPanel Enterprise edition has billing integrations with WHMCS and FOSSBilling.

OpenPanel WHMCS module allows users to integrate billing automations with their OpenPanel server.

OpenPanel

To setup WHMCS to use your OpenPanel server follow these steps:

Enable API

First make sure that API access is enabled by going to OpenAdmin > API or by running opencli config get api from the terminal: enable_api If API is not enabled, click on the "Enable API access" button or from terminal run

opencli config update api on

We recommend creating new Administrator user for API, to create a new user navigate to OpenAdmin > OpenAdmin Settings and create new admin user, or from terminal run:

opencli admin new USERNAME_HERE PASSWORD_HERE

Whitelist on OpenPanel

On OpenPanel server make sure that the OpenAdmin port 2087 is open on OpenAdmin > Firewall or whitelist the IP adress of your WHMCS server. to whitelist ip address from terminal run:

csf -a WHMCS_IP_HERE

or if using UFS:

ufw allow from WHMCS_IP_HERE

Create hosting package

Hosting packages need to be created on both OpenPanel and WHMCS servers. On OpenPanel server login to admin panel and on OpenAdmin > Plans create hosting packages that you will be assinging to users on WHMCS.

WHMCS

Install OpenPanel WHMC Module

Login to SSH for WHMCS server Navigate to path_to_whmcs/modules/servers Run this command to create a new folder and in it download the module:

git clone https://github.com/stefanpejcic/openpanel-whmcs-module.git openpanel

Whitelist on WHMCS

On WHMCS server also make sure that the 2087 port is opened or whitelist the IP address of your OpenPanel server.

WHMCS Module Setup

From WHMS navigate to: System Settings > Products & Services > Servers screenshot Click on Create New Server and under module select OpenPanel then add OpenPanel server IP, username and password for the OpenAdmin panel: create_whmcs_group

Create hosting package

On the WHMCS server create first a new group and then create new plans under this group. When creating products, make sure to select OpenPanel for Module and the newly created group screenshot2

Test

Create an order and create a new order to test OpenPanel API.