Difference between revisions of "IPMirror"

From WHMCS Documentation

m
(→‎Automatic Domain Synchronization)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
== About this Module ==
 +
 +
The Ipmirror module allows you to register and manage domains with IPMirror.
 
{{registrar
 
{{registrar
 
| register = yes
 
| register = yes
Line 11: Line 14:
 
| domainsync = yes
 
| domainsync = yes
 
}}
 
}}
 +
==Activation==
 +
 +
To activate and begin using the Ipmirror registrar module:
 +
 +
# Log in to the WHMCS Admin Area.
 +
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
 +
# Find '''Ipmirror''' in the list.
 +
# Click '''Activate'''.
 +
# Enter your IPMirror credentials using the [[#Configuration|configuration]] below.
 +
# 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.
  
−
==Requirements==
+
To access ccTLD Box through RAPI, you must:
−
The IP Mirror 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
 
  
−
==Configuration==
+
* Obtain valid ccTLD Box partner account with IPMirror.
−
To setup the IP Mirror Registrar integration in WHMCS, begin by going to '''Setup > Products/Services > Domain Registrars'''. Next choose Ipmirror from the dropdown menu of available registrars and click Go to view the configurable options for it. An explanation of each option can be found below:
+
* 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.
  
−
'''Username''' - The user login name given to you by IP Mirror to access your ccTLD Box
+
===Configuration===
  
−
'''Password''' - The password given to you to access your ccTLD Box
+
{| class="wikitable"
 +
!colspan="2"|Setting Name: DebugMode
 +
|-
 +
|colspan="2"|The IPMirror username to access your ccTLD Box.
 +
|-
 +
!colspan="2"|Setting Name: Password
 +
|-
 +
|colspan="2"|The password to access your ccTLD Box.
 +
|-
 +
!colspan="2"|Setting Name: ccTLDBoxUrl
 +
|-
 +
|colspan="2"|The URL to access your ccTLD Box RAPI. This generally uses the <tt><nowiki>https://</nowiki><partnerdomain>/RAPI/</tt> format, where <tt><partnerdomain></tt> is the domain for your ccTLD Box.
 +
|-
 +
!colspan="2"|Setting Name: AllowAdminContactChange
 +
|-
 +
|colspan="2"|If you enable this, a client logged in to the WHMCS Client Area can see and modify the administrative information and contacts for a domain. WHMCS administrators can always see and modify all contacts. We do not recommend this for contacts with a specified contact ID.
 +
|-
 +
!colspan="2"|Setting Name: DefaultRegContactId
 +
|-
 +
|colspan="2"|If this is a valid, existing ccTLD Box contact ID, this contact will always be the registrant contact for new domains. Usually, you should disable this in order to have a separate registrant contact for each domain.
 +
|-
 +
!Setting Name: ConnectionTimeout
 +
!Recommended Value: 20 (seconds)
 +
|-
 +
|colspan="2"|Time in seconds for the interface to wait to connect to ccTLD Box.
 +
|-
 +
!Setting Name: ExecutionTimeout
 +
!Recommended Value: 60 (seconds)
 +
|-
 +
|colspan="2"|Time in seconds for the interface to wait for ccTLD Box to execute a command.
 +
|-
 +
!Setting Name: DebugMode
 +
!Recommended Value: Off
 +
|-
 +
|colspan="2"|Enable this 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.
 +
|}
  
−
'''ccTLDBoxUrl''' - The URL to access your ccTLD Box RAPI. This has usually the form <nowiki>https://</nowiki><partnerdomain>/RAPI/ (where <partnerdomain> is the domain given to you to access your ccTLD Box).
+
== Automatic Registration ==
  
−
'''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.
+
WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.
  
−
'''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.
+
To enable automatic registration, see [[Domain Pricing]].
  
−
'''ConnectionTimeout''' - Time in seconds for the interface to wait to connect to ccTLD Box. Recommended setting: 20 (seconds)
+
== 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 [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.
  
−
'''ExecutionTimeout''' - Time in seconds for the interface to wait for ccTLD Box to execute a command. Recommended setting: 60 (seconds)
+
==Troubleshooting==
  
−
'''DebugMode''' - 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.
+
''N/A''
−
Recommended setting: Off
 
  
 
{{modules}}
 
{{modules}}

Latest revision as of 12:19, 7 June 2023

About this Module

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

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
Premium Domains Transfer Out Automation TLD Pricing Sync
No No No

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 or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
  3. Find Ipmirror in the list.
  4. Click Activate.
  5. Enter your IPMirror credentials using the configuration below.
  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.

Configuration

Setting Name: DebugMode
The IPMirror username to access your ccTLD Box.
Setting Name: Password
The password to access your ccTLD Box.
Setting Name: ccTLDBoxUrl
The URL to access your ccTLD Box RAPI. This generally uses the https://<partnerdomain>/RAPI/ format, where <partnerdomain> is the domain for your ccTLD Box.
Setting Name: AllowAdminContactChange
If you enable this, a client logged in to the WHMCS Client Area can see and modify the administrative information and contacts for a domain. WHMCS administrators can always see and modify all contacts. We do not recommend this for contacts with a specified contact ID.
Setting Name: DefaultRegContactId
If this is a valid, existing ccTLD Box contact ID, this contact will always be the registrant contact for new domains. Usually, you should disable this 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
Enable this 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.

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 or, prior to WHMCS 8.0, Setup > Automation Settings.

Troubleshooting

N/A

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - 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 - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible


Retrieved from "http://3.17.75.209/index.php?title=IPMirror&oldid=34094"