# Integration Apps

# WHMCS Module For Eenos

The Eenos whmcs module will help you to automate Eenos account provisioning from your WHMCS billing system.

# New Page



# Introduction

### Eenos WHMCS Module

The Eenos WHMCS module will help you to automate Eenos hosting accounts provisioning from your WHMCS billing system.

<p class="callout info">This is a root module, so you need root access to your Eenos server to use this module.</p>

This module uses the Eenos root API ( [**WAP API**](https://docs.eenos.com/books/api/chapter/wap-api "WAP API")) to automate the provisioning.

#### Requirements

The following requirements are needed to use this module within your WHMCS system.

- **WHMCS Version**: You need a WHMCS installation version 8.7 or higher to use.
- **PHP Version**: The WHMCS PHP must be 7.4 or higher
- **Eenos Server**: You need a server with Eenos control panel and root access
- **Eenos Root API**: You need to create an API user and password from your Eenos WAP control panel (**Preferences -&gt; API Manager -&gt; Create API Account)**
- **Open Ports**: You need to open ports 5555 and 5554 in your WHMCS server in the firewall.

If you have all the above requirements please proceed to the WHMCS module installation steps.

# Installation

### Getting Started with Eenos WHMCS Module Installation

The first step is to download the Eenos whmcs module and extract it. Then upload it to the WHMCS installation path.

You may download the latest version of the WHMCS module from [here: Eenos-1.0.tar.gz](https://download.eenos.com/whmcs-modules/Eenos-1.0.tar.gz "Eenos whmcs module")

After downloading the module, extract it and upload the document root of your whmcs installation.

#### Download Command 

```bash
wget -c https://download.eenos.com/whmcs-modules/Eenos-latest.tar.gz
```

#### Extract the module and upload it to WHMCS installation root

You may need to copy or upload the modules folder to the root of your whmcs installation.

```bash
tar -xzf Eenos-latest.tar.gz
cp -vrf Eenos/modules  /home/user/-path-to-whmcs-installation/
chown -R user:user /home/user/-path-to-whmcs-installation/modules
```

The installation has been completed now, proceed with the configuration of the Eenos WHMCS module.

# Configuration

### Login to WHMCS

You may login to whmcs admin area as an admin user to configure this module.

<p class="callout info">The Eenos WHMCS module currently supports only root operations on the Eenos hosting control panel.</p>

### Supported Features

<table border="1" id="bkmrk-create-suspend-unsus" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 24.9383%;"></col><col style="width: 24.9383%;"></col><col style="width: 24.9383%;"></col><col style="width: 24.9383%;"></col></colgroup><tbody><tr><td>**Create**</td><td>**Suspend**</td><td>**Unsuspend**</td><td>**Terminate**</td></tr><tr><td>**<span style="color: rgb(45, 194, 107);">Yes</span>**</td><td>**<span style="color: rgb(45, 194, 107);">Yes</span>**</td><td>**<span style="color: rgb(45, 194, 107);">Yes</span>**</td><td>**<span style="color: rgb(45, 194, 107);">Yes</span>**</td></tr></tbody></table>

<table border="1" id="bkmrk-change-package-chang" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 24.9383%;"></col><col style="width: 24.9383%;"></col><col style="width: 24.9383%;"></col><col style="width: 24.9383%;"></col></colgroup><tbody><tr><td>**Change Package**</td><td>**Change Password**</td><td>**Usage Updates**</td><td>**Client Area Link**</td></tr><tr><td><span style="color: rgb(45, 194, 107);">**Yes**</span></td><td><span style="color: rgb(45, 194, 107);">**Yes**</span></td><td><span style="color: rgb(45, 194, 107);">**Yes**</span></td><td><span style="color: rgb(45, 194, 107);">**Yes**</span></td></tr></tbody></table>

The following ports should be open for outbound connections from your WHMCS server: **5554 &amp; 5555**

In addition to the above basic features, this module supports Sync Data, Server Sync, and Account usage Sync services too.

### Adding an Eenos Server

This WHMCS module needs an Eenos server added inside your whmcs.

To set up an Eenos Server in WHMCS :

1. Go to **Configuration &gt; System Settings &gt; Servers**.
2. Click **Add New Serve**r.
3. Select ***Eenos*** from the menu.
4. Click **Go to Advanced Mode**
5. Enter Hostname
6. Enter IP Address
7. Enter Username with API User Name ( You can create from  **Eenos WAP -&gt; Preferences -&gt; API Manager** )
8. Enter the Password with the Password of the API user
9. Click **Test Connection**
10. Enter the desired additional server details.
11. Examine the displayed default port. If your server uses a different port, check **Override with Custom Port** and enter the correct port.
12. Click **Save Changes.**

Eenos WHMCS Module only uses the API Login credentials, we don't use the root password or other methods to access the API.

See a screenshot below,

[![new-server.png](https://docs.eenos.com/uploads/images/gallery/2023-10/scaled-1680-/new-server.png)](https://docs.eenos.com/uploads/images/gallery/2023-10/new-server.png)

<p class="callout info">It is important to click on the "Refresh Icon" on the server list so that the server packages will be fetched.</p>

### Creating a Server Group

The Eenos whmcs module needs a server group so that the module can automatically fetch the Eenos Packages from the server.

To Setup an Eenos Server Group in WHMCS :

1. Go to **Configuration &gt; System Settings &gt; Servers**
2. Click **Create New Group**
3. Enter **Name** ( Eg: Eenos Servers )
4. Click on the Server names from Selected Servers,
5. Click **Add**
6. Click **Save Changes**

 Now we created a server group with the added Eenos Servers.

### Creating Eenos Hosting Product

You can create a product that provisions accounts on your Eenos server at **Configuration &gt; System Settings &gt; Products/Services**

You can then create a product using an existing Eenos package or by defining custom options. You can also choose to create a reseller hosting product.

<p class="callout info">If you choose Custom options along with a package name, then the package values will be overridden by the custom values. </p>

#### Use an Existing Eenos Package

To create a hosting product that uses an existing Eenos package, use the following product configuration:

1. For Product Type, select **Shared Hosting.**
2. Enter **Product Name**
3. For Module Select **Eenos**
4. Click **Continue**
5. Click **Module Settings**
6. Make sure the Module Name is Eenos
7. Select the **Eenos Server Group**
8. Click **Save Changes**
9. Again **Click Details**
10. Click **Module Settings**
11. Select **Eenos Package Name**
12. Click **Save Changes**

Now you have a shared hosting product in whmcs with an Eenos package.

#### Defining Custom Options

To create a hosting product with a custom package, use the following product configuration:

1. For Product Type, select **Shared Hosting.**
2. Enter **Product Name**
3. For Module Select **Eenos**
4. Click **Continue**
5. Click **Module Settings**
6. Make sure the Module Name is Eenos
7. Select the **Eenos Server Group**
8. Click **Save Changes**
9. Again Click **Details**
10. Click **Module Settings**
11. Select **Eenos Package Name**
12. Enter the desired values of the package options
13. Click **Save Changes.**

<p class="callout info">To assign unlimited values to a feature please use the keyword "**unlimited**". We don't consider zero as unlimited. </p>

### [![shared_hosting.png](https://docs.eenos.com/uploads/images/gallery/2023-10/scaled-1680-/shared-hosting.png)](https://docs.eenos.com/uploads/images/gallery/2023-10/shared-hosting.png)

### Creating Eenos Reseller Package

To create a hosting product for a reseller account, use the following product configuration:

1. For Product Type, select **Reseller Hosting.**
2. Enter **Product Name**
3. For Module **Select Eenos**
4. Click **Continue**
5. Click **Module Settings**
6. Make sure the Module Name is Eenos
7. Select the **Eenos Server Group**
8. Click **Save Changes**
9. Again **Click Details**
10. Click **Module Settings**
11. Select **Eenos Package Name**
12. Enter the desired values of the package options
13. Enter the Reseller Options
14. Click **Save Changes.**

You may need to make sure the following reseller options configured:

- **Reseller Ownership**, if you like to allow the reseller to own his accounts. It is dangerous.
- **Limit Reseller by Number**, How many accounts a reseller can create. Default unlimited.
- **Reseller Disk Quota**, The maximum allowed disk usage on all sub-accounts. Default unlimited.
- **Reseller Bandwidth**, The maximum allowed bandwidth usage on all sub-accounts. Default unlimited.

<p class="callout warning">If you allow "**unlimited**" in reseller features it will allow the reseller to do overselling of the resources. </p>

[![reseller_hosting.png](https://docs.eenos.com/uploads/images/gallery/2023-10/scaled-1680-/reseller-hosting.png)](https://docs.eenos.com/uploads/images/gallery/2023-10/reseller-hosting.png)

If your Eenos server is enabled with **Reseller Chain**, which will allow multi-level reseller accounts. That means a reseller can create other resellers.

To Enable Multi-level Chained reselling Login to:

 **Eenos WAP -&gt; Automation -&gt; Tweak Settings -&gt; Advanced Tweaks -&gt; Multi-Level Reselling**