From WHMCS Documentation

Revision as of 15:50, 30 January 2018 by Nathan (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Supported Features

Register Transfer Renew Registrar Lock
Yes Yes Yes Yes
Update Nameservers Update WHOIS Get EPP Code Register Nameservers
Yes Yes No Yes
DNS Record Management Email Forwarding Domain Release Domain Sync Script
Yes Yes No Yes


To activate and begin using the Ipmirror registrar module, follow the steps below:

  1. Login to your WHMCS Admin Area
  2. Navigate to Setup > Products/Services > Domain Registrars
  3. Locate Ipmirror in the list
  4. Click the Activate button
  5. Enter your Ipmirror API credentials
  6. Click Save Changes to complete the process


The Ipmirror module connects WHMCS with the ccTLD Box Registrar Application Interface (RAPI). This allows WHMCS to pass certain domain operations (e.g. domain registrations etc.) through to IP Mirror’s ccTLD Box in real-time without any manual intervention. In order to access ccTLD Box through RAPI you will need to the following information from IP Mirror:

  • A valid ccTLD Box partner account with IP Mirror
  • Inform IP Mirror about the IP address of the WHMCS server(s) you plan to use the interface on, so that the firewall can be configured accordingly
  • Your partner-specific URL to the ccTLD Box RAPI


Setting Name: DebugMode
The user login name given to you by IP Mirror to access your ccTLD Box.
Setting Name: Password
The password given to you to access your ccTLD Box.
Setting Name: ccTLDBoxUrl
The URL to access your ccTLD Box RAPI. This has usually the form https://<partnerdomain>/RAPI/ (where <partnerdomain> is the domain given to you to access your ccTLD Box).
Setting Name: AllowAdminContactChange
If ticked, a client logged on to the WHMCS client area can see and modify the administrative/contacts of a domain (WHMCS administrators can always see/modify all contacts). Not recommended for those contacts for which a default contact Id (see below) is specified.
Setting Name: DefaultRegContactId
If this field is filled with a valid (i.e. existing) ccTLD Box contact Id, this same contact will always be used as the registrant contact for new domains. Usually, this box is not ticked in order to have a separate registrant contact for each domain.
Setting Name: ConnectionTimeout Recommended Value: 20 (seconds)
Time in seconds for the interface to wait to connect to ccTLD Box.
Setting Name: ExecutionTimeout Recommended Value: 60 (seconds)
Time in seconds for the interface to wait for ccTLD Box to execute a command.
Setting Name: DebugMode Recommended Value: Off
Tick this to output debug information such as parameters, function calls etc. onscreen (the synchronization script will output the information to the console). This only works for users with administrator privileges. Please be careful and only use this option when asked to provide debug information by IP Mirror, and do not forget to uncheck it again afterwards.

Automatic Registration

WHMCS allows you to setup automatic domain registration on a per extension basis enabling you to use different registrars for different TLDs to give you the flexibility to offer more extensions and always get the best value.

To enable automatic registration, please refer to Configuring Automatic Registration

Automatic Domain Synchronization

The Ipmirror module supports automatic domain synchronization for syncing of expiry dates and status changes for incoming transfers.

To enable this functionality, you need to ensure you have the Domain Sync Enabled in Setup > General Settings > Domains and ensure you have the Domain Sync Cron configured on your system.

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin - VePortal
Lxadmin - Virtualmin Pro - XPanel - HyperVM - FluidVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer
BluePay - BluePay Echeck - BluePay Remote - Boleto - CamTech - CashU - CC Avenue - ChronoPay
Cyberbit - Direct Debit - EMatters - E-Path - eProcessingNetwork
eWAY Tokens - F2B - FastHosts - Finansbank - GarantiBank - Gate2Shop - LinkPoint
IMSP - Inpay - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment
Merchant Partners - Merchant Warrior - IDEALMollie - Moneris - Moneris Vault
Skrill 1-Tap - SlimPay - NaviGate - NETbilling - Netregistry Pay - NoChex - NTPNow
Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - Paymex - PayPal - PayPal Express Checkout - PayPal Payments Pro
PayPoint.net (SecPay) - Payson - Payza - Planet Authorize - SagePay - ProtX VSP Form - PSIGate
Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens - SecPay - SecurePay - SecurePay AU
Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible