Fresh Install or Upgrade Checklist

Download Packages

The release packages are normally provided from the client area using filenames similar to these:

Install or Upgrade the WHMCS Modules

1. Back up your WHMCS files and database before replacing any production module files.
2. Upload and extract the FusionPBX WHMCS server module package into the WHMCS installation following the module package instructions.
3. Upload and extract the ictVoIP billing module package into the WHMCS installation following the module package instructions.
4. Review WHMCS module settings after upload, especially server hostname, SSL option, API user username, API user password, and Access Hash.

Recommended FusionPBX API User

Create a dedicated FusionPBX API user at the main host-level domain and assign that user superadmin permissions. Use this dedicated account in WHMCS instead of a personal administrator login.

• Example username: apiuser
• Example password: pass for illustration only; use a strong unique password in production.
• Required role: superadmin
• WHMCS fields: enter this account in the FusionPBX Server Username and Password fields, and enable SSL mode.

Upload the FusionPBX External APIs

Upload the ictvoip_fpbx5-3_apis folder to the FusionPBX server root directory:

/root/ictvoip_fpbx5-3_apis/

From the FusionPBX server CLI, run:

cd /root/ictvoip_fpbx5-3_apis/
chmod +x install_apis.sh
./install_apis.sh

If you are logged in as a sudo user:

cd /root/ictvoip_fpbx5-3_apis/
chmod +x install_apis.sh
sudo ./install_apis.sh

What the API Installer Updates

• Gateway management and provisioning endpoints
• Domain management endpoints
• Extension management endpoints
• Registration and system status endpoints
• CDR and WHMCS test connection endpoints
• IP whitelist security and shared secret validation

Check Installer Output

When the installer finishes, review the CLI output before closing the terminal. Confirm that the run completed without errors and that completion validation messages passed.

• Look for successful copy or deployment messages.
• Confirm permissions and ownership updates completed.
• Confirm nginx and PHP-FPM restart steps completed.
• Review any warning or error lines before testing WHMCS.
• Keep a copy of the output if you need to open a support ticket.

Optional Dry Run

To preview what the installer will do without applying changes, run:

cd /root/ictvoip_fpbx5-3_apis/
./install_apis.sh --dry-run

Post-Install Validation

1. Confirm the FusionPBX web interface still loads over HTTPS.
2. Open the API whitelist manager and confirm the WHMCS server IP is allowed.
3. In WHMCS, edit the FusionPBX server entry and click Test Connection.
4. Confirm the WHMCS server has SSL Connection enabled and uses the FusionPBX FQDN.
5. Confirm the WHMCS Server Username and Password are valid FusionPBX API user credentials, normally a dedicated host-level superadmin account.
6. Confirm the WHMCS Server Access Hash fallback matches the FusionPBX API Key exactly.

Whitelist manager:

https://your-fusionpbx-server.com/app/xml_cdr/whitelist_manager.php

Test connection endpoint:

https://your-fusionpbx-server.com/app/xml_cdr/chkcon.php

Common Issues to Check

• 403 Forbidden: WHMCS server IP is not whitelisted or the request is coming from an unexpected public IP.
• 401 Unauthorized: FusionPBX API credentials are incorrect, permissions are insufficient, or the Access Hash does not match.
• 404 Not Found: API files were not deployed to the expected FusionPBX application paths.
• SSL errors: FusionPBX must use a valid FQDN SSL certificate for WHMCS communication.

Upgrade Notes

• Run the external API installer again when the package is upgraded.
• The existing whitelist file is backed up and preserved.
• Review release notes before replacing production files.
• Test in development or during a maintenance window before applying to production.