The Ipmirror module allows you to register and manage domains with IPMirror.

Supported Features #

Activation #

To activate and begin using the Ipmirror registrar module:

1. Log in to the WHMCS Admin Area.
2. Go to Configuration () > System Settings > Domain Registrars.
3. Find Ipmirror in the list.
4. Click Activate.
5. Enter your IPMirror credentials:
   • DebugMode — The IPMirror username to access your ccTLD Box.
   • Password — The password to access your ccTLD Box.
   • ccTLDBoxUrl — The URL to access your ccTLD Box RAPI. This URL generally uses the https://<partnerdomain>/RAPI/ format, where <partnerdomain> is the domain for your ccTLD box.
   • AllowAdminContactChange — Whether to allow an authenticated client to see and modify the administrative information and contacts for a domain.
     • WHMCS admins can always see and modify all contacts.
     • We do not recommend this for contacts with a specified contact ID.
   • DefaultRegContactId — A valid, existing ccTLD box contact ID that will always be the registrant contact for new domains. Usually, we recommend disabling this to have a separate registrant contact for each domain.
   • ConnectionTimeout — The time, in seconds, for the interface to wait to connect to ccTLD box. We recommend a value of 20.
   • ExecutionTimeout — The time, in seconds, for the interface to wait for ccTLD box to execute a command. We recommend a value of 60.
   • DebugMode — Whether to output debug information like parameters or function calls onscreen, with the synchronization script outputting the information to the console.
     • This only works for users with admin privileges.
     • Only use this option to provide debugging information to IPMirror and disable it immediately afterwards.
     • We strongly recommend setting this to Off.
6. Click Save Changes.

Requirements #

The Ipmirror module connects WHMCS with the ccTLD Box Registrar Application Interface (RAPI). This allows WHMCS to pass certain domain operations (for example, domain registrations) to IPMirror’s ccTLD Box in real time without manual intervention.

To access ccTLD Box through RAPI, you must:

• Obtain valid ccTLD Box partner account with IPMirror.
• Update IPMirror’s firewall configuration with the IP address of the WHMCS server(s) you plan to use.
• Find your partner-specific URL to the ccTLD Box RAPI.

Automatic Registration #

WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.

To enable automatic registration, see Domain Pricing.

Automatic Domain Synchronization #

This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.

To use this, enable Domain Sync Enabled and configure the domain sync task at Configuration () > System Settings > Automation Settings.

Last modified: November 12, 2024