Documentation

Installation Guide

Follow these steps to install and configure the Zispa self-hosted WHMCS registrar module on your server. The whole process takes about 5–10 minutes.

Prerequisites

WHMCS Version
8.0 or higher
PHP Version
7.4 or higher
cURL Extension
Enabled (php-curl)
License Key
Active Zispa license
API Endpoint
Your billing site URL
FTP / SFTP Access
To your WHMCS server

PHP & WHMCS Version Compatibility

We ship separate Ioncube-encoded builds for each supported PHP version. Download the build that matches the PHP version running on your WHMCS server.

Download Build PHP Version WHMCS Version Status
php74 PHP 7.4 WHMCS 8.0 – 8.5 Legacy
php82 PHP 8.2 WHMCS 8.6 – 8.9 Stable
php84 PHP 8.4 WHMCS 8.10+ Latest

Not sure which PHP version your WHMCS server is running? In WHMCS go to Utilities → System → PHP Info to check.

1

Download the Module

Download the correct build for your PHP version from the button below, or from the download page. See the compatibility table above if you're unsure which build to pick.

After downloading, extract the zip file on your local machine to reveal the modules/ folder.

2

Upload to Your WHMCS Server

Using FTP, SFTP, or your hosting control panel file manager, upload the module folder to your WHMCS installation.

Directory structure after uploading:

# Upload the contents so the structure looks like this: your-whmcs-root/ └── modules/ └── registrars/ └── zispa/ <-- this is the module folder ├── zispa.php ├── hooks.php ├── lib/ │ └── lib.php ├── logo.png └── template.txt
Important: Make sure the folder is named exactly zispa (all lowercase). WHMCS uses the folder name to identify registrar modules.
3

Activate the Registrar in WHMCS

Log in to your WHMCS admin area and navigate to the registrar settings:

  1. a
    Go to Setup → Products/Services → Domain Registrars
  2. b
    Find Zispa in the list of available registrars.
  3. c
    Click Activate to enable it.

If Zispa doesn't appear in the list, double-check that the folder was uploaded to the correct path and that the folder is named zispa.

4

Configure Module Settings

After activating the module, click Configure to enter your settings.

Required Configuration Fields

API URL
The base URL of your licensing/billing site.
https://your-billing-site.com
License Key
Your unique license key (format: ZISPA-XXXXXXXXXXXXXXXX). Find this in your dashboard after logging in.
→ Get your license key from the dashboard
Test Mode
Enable during initial setup to test without live transactions. Disable for production.

Click Save Changes after entering your settings.

5

Test the Connection

After saving your configuration, verify the connection is working correctly:

  1. 1
    Check the registrar page
    In WHMCS, go back to Domain Registrars. The Zispa module should show as Active.
  2. 2
    Test domain lookup
    Try checking the availability of a domain from your WHMCS order form to verify the API connection is live.
  3. 3
    Check the activity log
    In WHMCS go to Utilities → Activity Log to see if any errors are recorded from the registrar.
You're all set! Once the domain check works, your registrar module is fully operational. You can now assign it to TLDs under Setup → Products/Services → Domain Pricing.

Troubleshooting

Zispa doesn't appear in the Domain Registrars list
Ensure the module folder is named exactly `zispa` (lowercase) and is placed in `your-whmcs/modules/registrars/`. Check file permissions (755 for directories, 644 for files).
License verification fails with "License not found"
Double-check your license key is copied exactly from your dashboard (format: ZISPA-XXXXXXXXXXXXXXXX). Ensure the API URL does not have a trailing slash.
License is suspended immediately after first use
The license is domain-locked on first use. If the domain used during first verification doesn't match future requests, it will be suspended. Contact your administrator to reset the domain lock from the dashboard.
API connection timeout or cURL error
Ensure your WHMCS server can reach your billing site URL over HTTPS. Check that your billing site's SSL certificate is valid and that no firewall rules are blocking outgoing connections on port 443.
Module works in test mode but not in production
Verify that Test Mode is disabled in the module configuration and that your license key is active (not expired) in your dashboard.

Ready to install?

Pick the build for your PHP version and follow the steps above.