actra / actra-whmcs-registrar
Actra Registrar Module for WHMCS.
Package info
github.com/Actra-AG/actra-whmcs-registrar
Type:whmcs-registrar
pkg:composer/actra/actra-whmcs-registrar
Requires
- php: >=8.3
- ext-curl: *
Requires (Dev)
- actra/coding-standard: ^1.27
- phpunit/phpunit: ^12.5
- symfony/console: ^7.4
- symfony/event-dispatcher: ^7.4
- symfony/filesystem: ^7.4
- symfony/finder: ^7.4
- symfony/options-resolver: ^7.4
- symfony/process: ^7.4
- symfony/stopwatch: ^7.4
- symfony/string: ^7.4
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Actra Registrar Module for WHMCS.
Description
This module provides functionality for registering, transferring, and renewing domains through Actra's registrar API within the WHMCS platform.
The module communicates with the Actra Domains REST API using bearer-token authentication and JSON requests.
Domain properties such as the registration status, the transfer lock, and the restorable state are read from the
normalized fields of the API response. The registry-specific status codes are therefore interpreted by the Actra Domains
API rather than by this module, which requires an API that provides the normalizedStatus field and the derived
boolean fields of the domain response.
Features
- Register Domain
- Transfer Domain
- Renew Domain (where applicable)
- Get EPP Code
- Manage Nameservers
- Manage Contact Details
- DNSSEC Support
Known Issues
WHMCS 9.0.x: persistent registrar configuration warning
WHMCS 9.0.x has a confirmed admin-area session handling issue where a registrar configuration validation error can remain visible after the configuration has subsequently been corrected and saved successfully.
This can happen when the registrar configuration validation initially fails, for example because of an invalid API key. WHMCS stores the validation message in the admin session as a configuration warning. In affected WHMCS versions, a later successful validation does not reliably clear that session warning during the admin-area redirect lifecycle.
Symptoms:
- The Actra API returns a successful response when validating the corrected credentials.
- WHMCS still displays the previous
Action Requiredmessage. - The message disappears after logging out and back in, or when using a fresh admin session.
This is a visual WHMCS admin UI issue only. It does not affect the saved registrar configuration or the actual registrar module functionality.
Workaround:
- Log out of the WHMCS admin area and log back in.
- Alternatively, use a fresh browser session.
This module intentionally does not implement a local workaround for this issue, because reliable programmatic mitigation would require changes outside the module directory, such as a global WHMCS hook, which is outside the deployment scope of this Composer-installed registrar module.
Transfer Behavior
Incoming domain transfers submit WHMCS contact data directly to the Actra Domains API. The Actra Domains backend resolves the appropriate registry from the TLD and creates or reuses matching contacts automatically.
When available, separate WHMCS Admin, Tech, and Billing contact data is submitted for the transfer. If role-specific contact data is incomplete or unavailable, the module falls back to the registrant contact data.
Installation
WHMCS loads the module from modules/registrars/actra and autoloads its classes from the lib directory there. The
module has no runtime dependencies.
Via Composer (Recommended)
Do not run Composer in the WHMCS root directory: WHMCS ships its own vendor directory, which Composer would
overwrite. Install the package in a separate directory outside the WHMCS installation instead, and link the module
directory into WHMCS:
mkdir -p /path/to/whmcs-modules && cd /path/to/whmcs-modules composer require actra/actra-whmcs-registrar ln -s /path/to/whmcs-modules/vendor/actra/actra-whmcs-registrar/src/actra /path/to/whmcs/modules/registrars/actra
Update with composer update actra/actra-whmcs-registrar in that directory. If your hosting does not allow symbolic
links (e.g. open_basedir), copy the directory instead after every update:
cd /path/to/whmcs-modules/vendor/actra/actra-whmcs-registrar
rsync -a --delete src/actra/ /path/to/whmcs/modules/registrars/actra/
Read the CHANGELOG before updating: minor versions may require changes of the module settings.
Manual Installation
- Download the latest release.
- Extract the files and upload the contents of the
src/actradirectory to your WHMCS installation atmodules/registrars/actra.
Configuration
- Log in to your WHMCS Admin Area.
- Navigate to System Settings > Domain Registrars.
- Activate the actra module.
- Enter the API URL (base URL of the Actra Domains REST API, ending with
/api/v1), your API key and your customer number at Actra, and configure the available options.
Development
The project follows the Actra coding standard (see AGENTS.md). Run the code style check, the static analysis and the tests with DDEV (PHP 8.3, the PHP version supported by WHMCS):
ddev start ddev composer install ddev composer check
Authors
License
This project is licensed under the MIT License – see the LICENSE file for details.
Support
For support, please visit https://www.actra.ch/.