Difference between revisions of "IPMirror"
(Created page with '{{registrar | register = yes | transfer = yes | renew = yes | lock = yes | dns = yes | whois = yes | regns = yes | dnsmanagement = yes | emailforwarding = yes }}') |
|||
| Line 10: | Line 10: | ||
| emailforwarding = yes | | emailforwarding = yes | ||
}} | }} | ||
| + | |||
| + | ==Requirements== | ||
| + | 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== | ||
| + | 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: | ||
| + | |||
| + | '''Username''' - The user login name given to you by IP Mirror to access your ccTLD Box | ||
| + | |||
| + | '''Password''' - The password given to you to access your ccTLD Box | ||
| + | |||
| + | '''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). | ||
| + | |||
| + | '''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. | ||
| + | |||
| + | '''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. | ||
| + | |||
| + | '''ConnectionTimeout''' - Time in seconds for the interface to wait to connect to ccTLD Box. Recommended setting: 20 (seconds) | ||
| + | |||
| + | '''ExecutionTimeout''' - Time in seconds for the interface to wait for ccTLD Box to execute a command. Recommended setting: 60 (seconds) | ||
| + | |||
| + | '''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. | ||
| + | Recommended setting: Off | ||
Revision as of 12:05, 16 October 2012
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 | No |
| Premium Domains | Transfer Out Automation | TLD Pricing Sync | |
| No | No | No |
Requirements
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
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:
Username - The user login name given to you by IP Mirror to access your ccTLD Box
Password - The password given to you to access your ccTLD Box
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).
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.
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.
ConnectionTimeout - Time in seconds for the interface to wait to connect to ccTLD Box. Recommended setting: 20 (seconds)
ExecutionTimeout - Time in seconds for the interface to wait for ccTLD Box to execute a command. Recommended setting: 60 (seconds)
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. Recommended setting: Off