Opterius Panel - WHMCS Server Module

Automatically provision, suspend, unsuspend, and terminate hosting accounts on Opterius Panel directly from WHMCS.

Features

• Create Account - Automatically provisions hosting accounts when a customer purchases a plan
• Suspend Account - Suspends accounts when invoices are overdue
• Unsuspend Account - Reactivates accounts when payment is received
• Terminate Account - Deletes accounts when services are cancelled
• Change Password - Allows customers to change their account password from the WHMCS client area
• Change Package - Handles plan upgrades and downgrades
• Usage Statistics - Syncs disk and bandwidth usage to WHMCS automatically
• Client Area Link - "Login to Panel" button in the WHMCS client area
• Test Connection - Verify your server connection from the WHMCS admin

Requirements

• WHMCS 8.0 or later
• Opterius Panel 1.0 or later
• PHP 8.1 or later (on the WHMCS server)
• An API key generated from Opterius Panel

Installation

1. Download the module

Download or clone this repository:

git clone https://github.com/opterius/whmcs-module.git

2. Copy to WHMCS

Copy the modules/servers/opterius/ folder into your WHMCS installation:

cp -r modules/servers/opterius/ /path/to/whmcs/modules/servers/opterius/

Your WHMCS directory should look like:

whmcs/
  modules/
    servers/
      opterius/
        opterius.php
        lib/
          OpterusAPI.php

3. Generate an API key in Opterius Panel

1. Log into your Opterius Panel as an admin
2. Go to Server Mode > Settings > API Keys
3. Click Create API Key
4. Name it (e.g., "WHMCS Production")
5. Select permissions: check all (or select only what you need)
6. Optionally restrict to your WHMCS server's IP address for security
7. Click Generate API Key
8. Copy the key immediately - it is only shown once

4. Add the server in WHMCS

1. In WHMCS, go to Configuration > System Settings > Servers
2. Click Add New Server
3. Fill in the details:

Field	Value
Name	Any name (e.g., "Opterius Server 1")
Hostname	Your Opterius Panel hostname (e.g., panel.example.com)
IP Address	Your server's IP address
Module	Select Opterius from the dropdown
Port	8443 (default Opterius Panel port)
Secure	Check this box (HTTPS)
Access Hash	Paste the API key from step 3

4. Click Test Connection to verify everything works
5. Click Save Changes

5. Create a product in WHMCS

1. Go to Configuration > System Settings > Products/Services

2. Create a new product or edit an existing one

3. On the Module Settings tab:

   • Module Name: Select Opterius
   • Server Group: Select the group containing your Opterius server
   • Package Name: Enter the exact name of the package as configured in Opterius Panel (e.g., "Starter", "Business", "Enterprise")

4. Save the product

That's it! When customers purchase this product, WHMCS will automatically create their hosting account on your Opterius Panel server.

How Package Mapping Works

WHMCS products are mapped to Opterius packages by name. The "Package Name" field in the WHMCS product configuration must match the package name in Opterius Panel exactly.

For example:

• Opterius Panel has a package called "Starter"
• In WHMCS product Module Settings, enter "Starter" in the Package Name field
• When a customer purchases this product, WHMCS tells Opterius to create the account with the "Starter" package

To see available packages, go to Server Mode > Packages in your Opterius Panel.

What Happens During Provisioning

When a customer completes a purchase, WHMCS sends the following to Opterius:

1. Domain - The domain entered during checkout
2. Username - Generated by WHMCS (or entered by the customer)
3. Password - Generated by WHMCS (or entered by the customer)
4. Package - The package name from the product configuration
5. Client Details - Customer's name and email

Opterius then:

• Creates a user account (or reuses an existing one if the email already exists)
• Creates the hosting account with the specified package
• Sets up the domain with Nginx, PHP-FPM, DNS zone, and auto-SSL

API Endpoints Used

WHMCS Function	API Endpoint	Description
CreateAccount	POST /api/v1/accounts/create	Provision a new account
SuspendAccount	POST /api/v1/accounts/suspend	Suspend an account
UnsuspendAccount	POST /api/v1/accounts/unsuspend	Unsuspend an account
TerminateAccount	POST /api/v1/accounts/terminate	Delete an account
ChangePassword	POST /api/v1/accounts/password	Change account password
ChangePackage	POST /api/v1/accounts/package	Change account package
UsageUpdate	POST /api/v1/accounts/usage	Get disk/bandwidth usage
TestConnection	POST /api/v1/test	Verify API connectivity

Troubleshooting

"Module not found" in WHMCS

Make sure the module files are in the correct location: whmcs/modules/servers/opterius/opterius.php

"Test Connection" fails

• Verify the hostname and port are correct
• Ensure HTTPS is enabled (check the "Secure" box)
• Check that the API key is valid and not expired
• If you set an IP whitelist on the API key, make sure your WHMCS server's IP is included
• Check that port 8443 is open in your firewall

Account creation fails with "Package not found"

The package name in WHMCS must match the Opterius package name exactly (case-sensitive). Check the available packages in Opterius Panel under Server Mode > Packages.

Account creation fails with "Account limit reached"

Your Opterius license has reached the maximum number of accounts. Upgrade your license at opterius.com.

Usage statistics not updating

Make sure the WHMCS cron job is running. Usage is synced when WHMCS runs its daily automation tasks.

Security Recommendations

1. Use IP whitelisting - When creating the API key in Opterius, restrict it to your WHMCS server's IP address
2. Use minimal permissions - Only grant the permissions your WHMCS integration needs
3. Use HTTPS - Always check "Secure" in the WHMCS server configuration
4. Rotate keys periodically - Generate a new API key and revoke the old one periodically

Support

• Documentation: opterius.com/docs
• Issues: github.com/opterius/whmcs-module/issues

License

MIT License - see LICENSE for details.