VentraIP Wholesale - Revision history

JuanR: /* Automatic Domain Synchronization */

2023-06-07T12:24:40Z

‎Automatic Domain Synchronization

SarahK at 18:20, 10 May 2022

2022-05-10T18:20:47Z

SarahK at 20:42, 11 April 2022

2022-04-11T20:42:07Z

SarahK: /* Activation */

2021-09-28T15:26:32Z

‎Activation

SarahK at 18:49, 4 August 2020

2020-08-04T18:49:49Z

John at 22:49, 13 February 2018

2018-02-13T22:49:09Z

Lawrence at 14:52, 13 February 2018

2018-02-13T14:52:50Z

Lawrence: /* Activation */

2018-02-13T14:50:41Z

‎Activation

Nathan at 16:00, 30 January 2018

2018-01-30T16:00:14Z

Samcraven: Fog4622

2014-06-17T23:15:16Z

Fog4622

@@ Line 79: / Line 79: @@
 == 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''' in the '''[[Domains_Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.
+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'''.
 ==Troubleshooting==

@@ Line 25: / Line 25: @@
 # Open a ticket with VentraIP Wholesale and request server IP address access.
 #* VentraIP Wholesale's API is IP address-restricted.
-#* You can find the IP address to whitelist at '''Help > License Information''' in the WHMCS Admin Area.
+#* You can find the IP address to whitelist at '''Help > [[License Information]]''' in the WHMCS Admin Area.
 #* If you do not obtain access before proceeding, you will receive a <tt>SoapFault exception: [HTTP] Forbidden</tt> error.
-# Log in to the WHMCS Admin Area.
+# 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 '''Ventraip''' in the list.
@@ Line 37: / Line 37: @@
 === Wholesale System Configuration Options ===
-Before configuring the module inside of WHMCS, you will need to add your server’s IP address to the '''Allowed IP Addresses''' section in the Wholesale System via '''Your Account > API Information'''. For information on the IP address that your WHMCS installation will use to connect to the Wholesale System, contact your hosting provider. Alternatively, the IP address that your WHMCS installation is using to connect to the Wholesale System is shown under the '''Configure''' options of the WHMCS module:
+Before configuring the module inside of WHMCS, you will need to add your server’s IP address to the '''Allowed IP Addresses''' section in the Wholesale System via '''Your Account > API Information'''.
 [[File:Vent_2.png]]
@@ Line 49: / Line 52: @@
 After you have verified you are running the latest version of the WHMCS module, and applied the configuration changes required in the Wholesale System, you will need to configure and enable the module through WHMCS.
-Begin by going, in WHMCS, 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'''. Scroll down the page until you find ‘Ventraip’, click Activate and then Configure to modify the settings in the module.
+In WHMCS, begin by going 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'''. Scroll down the page until you find '''Ventraip''', click '''Activate''', and then click '''Configure''' to modify the settings in the module.
-You will need to insert your Reseller ID and API Key, which can be found in the Wholesale System  Your Account > API Information. You will also be presented with an option that will allow you to control how AU domain name transfers & renewals are handled. More information on this function is included below.
+You will need to insert your '''Reseller ID''' and '''API Key''', which can be found in the Wholesale System at '''Your Account > API Information'''. You will also be presented with an option that will allow you to control how AU domain name transfers and renewals are handled. More information on this function is included below.
 === Renewal on Transfer (.AU) ===
@@ Line 57: / Line 60: @@
 When configuring the module via WHMCS, you will be presented with an option to control how AU domain name transfers & renewals are handled.
-If you leave the ‘Renewal of Transfer (.AU)’ box unticked, when a .AU domain name is submitted for transfer it will not be renewed irrespective of the expiration date of the domain. If the box is checked (and the option enabled), when a .AU domain is submitted for transfer that is within 90 days of expiration, it will be submitted as a transfer + renewal (and the amount will be deducted from your Wholesale System balance).
+If you leave the '''Renewal of Transfer (.AU)''' box unticked, when a .AU domain name is submitted for transfer it will not be renewed irrespective of the expiration date of the domain. If the box is checked (and the option enabled), when a .AU domain is submitted for transfer that is within 90 days of expiration, it will be submitted as a transfer and renewal (and the amount will be deducted from your Wholesale System balance).
 [[File:Vent_3.png]]
-This will not charge your customers through WHMCS for the renewal - it will simply submit the domain for a transfer + renewal. You will be able to view your Transaction history through the Wholesale System > Finance > Transactions to see any domain transfer + renewals, which you can retrospectively bill your clients for.
+This will not charge your customers through WHMCS for the renewal. It will submit the domain for a transfer and renewal. You will be able to view your Transaction history through the Wholesale System at '''Finance > Transactions''' to see any domain transfer and renewals, which you can retrospectively bill your clients for.
 === DNS Management & Email Forwarding ===
-Before your clients will be able to use the DNS Management or Email Forwarding services through the WHMCS Client Area, you’ll need to enable the option (on a per domain basis) via Wholesale System > Manage (or search for the domain) > Name Servers > Click Email/URL Forwarding or DNS Hosting (depending on what you require).
+Before your clients will be able to use the DNS Management or Email Forwarding services through the WHMCS Client Area, you’ll need to enable the option (on a per domain basis) via '''Wholesale System > Manage > Name Servers > Click Email/URL Forwarding or DNS Hosting''' (depending on what you require).
-This will change the name servers on the domain to use the VentraIP Wholesale Email/URL Forwarding & DNS Hosting cluster, but you will be able to manage the records via the WHMCS Client Area upon making those changes. If you have not successfully made the required changes, you will be presented with an error message upon accessing those sections in  the WHMCS Client Area.
+This will change the name servers on the domain to use the VentraIP Wholesale Email/URL Forwarding and DNS Hosting cluster, but you will be able to manage the records via the WHMCS Client Area upon making those changes. If you have not successfully made the required changes, you will be presented with an error message upon accessing those sections in  the WHMCS Client Area.
 == Automatic Registration ==
@@ Line 87: / Line 90: @@
 Port 957 is being blocked by user's firewall, preventing connections to Ventraip API, server admin/hosting provider must open it.
-Server IP address has not been added to 'Allowed IP Addresses' list in the Wholesale System control panel under Your Account > API Information.
+Server IP address has not been added to 'Allowed IP Addresses' list in the Wholesale System control panel under '''Your Account > API Information'''.
 ===Unable to retrieve domain id===
@@ Line 95: / Line 98: @@
 ===Unable to update name servers on domain name===
-The new nameservers being submitted are being rejected by the System. Most likely they are invalid and not registered. Please confirm you have entered valid nameservers and try again.
+The new nameservers being submitted are being rejected by the system. Most likely they are invalid and not registered. Please confirm you have entered valid nameservers and try again.
 {{modules}}

@@ Line 1: / Line 1: @@
-<div class="errorbox">Please note that the VentraIP module previously distributed with WHMCS has been deprecated. The replacement can be obtained from https://marketplace.whmcs.com/product/3757
+== About this Module ==
 </div>
 {{registrar
 | register = yes
@@ Line 16: / Line 20: @@
 }}
 ==Activation==
-# [https://www.example.com/ Open a ticket] with VentraIP Wholesale and request server IP address access.
+To activate and begin using the Ventraip registrar module:
 #* VentraIP Wholesale's API is IP address-restricted.
 #* You can find the IP address to whitelist at '''Help > License Information''' in the WHMCS Admin Area.
-#* If you do not obtain access before proceeding, you will receive a <tt>SoapFault exception: [HTTP] Forbidden in ...</tt> error.
+#* If you do not obtain access before proceeding, you will receive a <tt>SoapFault exception: [HTTP] Forbidden</tt> error.
 # Log in to the WHMCS Admin Area.
-# Navigate 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'''.
+# 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'''.
-# Click '''Activate''' for '''Ventraip'''
+# Find '''Ventraip''' in the list.
 # Enter your Ventraip API credentials.
 # Click '''Save Changes'''.
-===Configuration===
+=== Wholesale System Configuration Options ===
-====Wholesale System Configuration Options====
+Before configuring the module inside of WHMCS, you will need to add your server’s IP address to the '''Allowed IP Addresses''' section in the Wholesale System via '''Your Account > API Information'''. For information on the IP address that your WHMCS installation will use to connect to the Wholesale System, contact your hosting provider. Alternatively, the IP address that your WHMCS installation is using to connect to the Wholesale System is shown under the '''Configure''' options of the WHMCS module:
 [[File:Vent_2.png]]
-''Note: For security reasons, there is a 5 to 10 minute delay before the allowed IP address is updated in the Wholesale System - so please be patient if you cannot connect initially.''
+For security reasons, there is a 5 to 10 minute delay before the allowed IP address is updated in the Wholesale System.
 [[File:Vent_1.png]]
-====Configuration through WHMCS====
+=== Configuration through WHMCS ===
 After you have verified you are running the latest version of the WHMCS module, and applied the configuration changes required in the Wholesale System, you will need to configure and enable the module through WHMCS.
@@ Line 50: / Line 53: @@
 You will need to insert your Reseller ID and API Key, which can be found in the Wholesale System  Your Account > API Information. You will also be presented with an option that will allow you to control how AU domain name transfers & renewals are handled. More information on this function is included below.
-====Renewal on Transfer (.AU)====
+=== Renewal on Transfer (.AU) ===
 When configuring the module via WHMCS, you will be presented with an option to control how AU domain name transfers & renewals are handled.
@@ Line 57: / Line 61: @@
 [[File:Vent_3.png]]
-''Note: This will not charge your customers through WHMCS for the renewal - it will simply submit the domain for a transfer + renewal. You will be able to view your Transaction history through the Wholesale System > Finance > Transactions to see any domain transfer + renewals, which you can retrospectively bill your clients for.''
+This will not charge your customers through WHMCS for the renewal - it will simply submit the domain for a transfer + renewal. You will be able to view your Transaction history through the Wholesale System > Finance > Transactions to see any domain transfer + renewals, which you can retrospectively bill your clients for.
 Before your clients will be able to use the DNS Management or Email Forwarding services through the WHMCS Client Area, you’ll need to enable the option (on a per domain basis) via Wholesale System > Manage (or search for the domain) > Name Servers > Click Email/URL Forwarding or DNS Hosting (depending on what you require).
 This will change the name servers on the domain to use the VentraIP Wholesale Email/URL Forwarding & DNS Hosting cluster, but you will be able to manage the records via the WHMCS Client Area upon making those changes. If you have not successfully made the required changes, you will be presented with an error message upon accessing those sections in  the WHMCS Client Area.
-==Automatic Registration==
+== 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 [[Domain Pricing|Configuring 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.
-==Automatic Domain Synchronization==
+To enable automatic registration, see [[Domain Pricing]].
-The VentraIP Wholesale 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 '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Domains''' or, prior to WHMCS 8.0, '''Setup > General Settings > Domains'''. Ensure you have the [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system.
+== Automatic Domain Synchronization ==
 ==Troubleshooting==
-'''SoapFault exception: [HTTP] Forbidden in /../modules/registrars/ventraip/ventraip.php:957'''<br>
-Port 957 is being blocked by user's firewall, preventing connections to Ventraip API, server admin/hosting provider must open it.<br>
+===SoapFault exception: [HTTP] Forbidden in /../modules/registrars/ventraip/ventraip.php:957===
 Server IP address has not been added to 'Allowed IP Addresses' list in the Wholesale System control panel under Your Account > API Information.
-'''Unable to retrieve domain id'''<br>
+===Unable to retrieve domain id===
 Domain does not exist in the Wholesale System. It could be that a transfer is in process, the error will disappear once the transfer is completed.
-'''Unable to update name servers on domain name'''<br>
+===Unable to update name servers on domain name===
 The new nameservers being submitted are being rejected by the System. Most likely they are invalid and not registered. Please confirm you have entered valid nameservers and try again.
 {{modules}}

@@ Line 16: / Line 16: @@
 }}
 ==Activation==
-To activate and begin using the VentraIP Wholesale registrar module, follow the steps below:
+To activate and begin using the VentraIP Wholesale registrar module:
-# Login to your WHMCS Admin Area
+# [https://www.example.com/ Open a ticket] with VentraIP Wholesale and request server IP address access.
 # Navigate 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'''.
-# Locate Ventraip in the list
+# Click '''Activate''' for '''Ventraip'''
-# Click the '''Activate''' button
+# Enter your Ventraip API credentials.
-# Enter your Ventraip API credentials
+# Click '''Save Changes'''.
 ===Configuration===
-Before beginning we suggest you check the API Information section of the Wholesale System to ensure you have the latest version of the WHMCS module installed. You will also require the Reseller ID & API Key from  the API Information section (in the Wholesale System) to configure the module in WHMCS correctly.
+Before you begin, check whether you have the latest version of the WHMCS method installed. You can check this in the API Information section of the Wholesale System to ensure you have the latest version of the WHMCS module installed. You will also require the Reseller ID & API Key from  the API Information section (in the Wholesale System) to configure the module in WHMCS correctly.
-'''Installation'''<br>
+====Installation====
 WHMCS includes a copy of the VentraIP Wholesale domain name module by default. When updates are released for our WHMCS module, they are provided to WHMCS to include in the next release. Sometimes there can be a short delay between the updated module being available in WHMCS and in general release to our Wholesale System clients. We suggest checking the Wholesale System > API Information to ensure that the latest version is running in your WHMCS installation. If you’re not running the latest version, please download the ZIP archive via the Wholesale System, and follow the installation instructions enclosed in the ZIP archive to update your WHMCS module.
-'''Wholesale System Configuration Options'''<br>
+====Wholesale System Configuration Options====
 Before configuring the module inside of WHMCS, you will need to add your server’s IP address to the ‘Allowed IP Addresses’ section in the Wholesale System via Your Account > API Information. For information on the IP address that your WHMCS installation will use to connect to the Wholesale System, please contact your web-hosting provider. Or alternatively, the IP address that your WHMCS installation is using to connect to the Wholesale System is shown under the Configure options of the WHMCS module:
@@ Line 49: / Line 43: @@
 [[File:Vent_1.png]]
-'''Configuration through WHMCS'''<br>
+====Configuration through WHMCS====
 After you have verified you are running the latest version of the WHMCS module, and applied the configuration changes required in the Wholesale System, you will need to configure and enable the module through WHMCS.
@@ Line 56: / Line 50: @@
 You will need to insert your Reseller ID and API Key, which can be found in the Wholesale System  Your Account > API Information. You will also be presented with an option that will allow you to control how AU domain name transfers & renewals are handled. More information on this function is included below.
-'''Renewal on Transfer (.AU)'''<br>
+====Renewal on Transfer (.AU)====
 When configuring the module via WHMCS, you will be presented with an option to control how AU domain name transfers & renewals are handled.
@@ Line 65: / Line 59: @@
 ''Note: This will not charge your customers through WHMCS for the renewal - it will simply submit the domain for a transfer + renewal. You will be able to view your Transaction history through the Wholesale System > Finance > Transactions to see any domain transfer + renewals, which you can retrospectively bill your clients for.''
-'''DNS Management & Email Forwarding'''<br>
+====DNS Management & Email Forwarding====
 Before your clients will be able to use the DNS Management or Email Forwarding services through the WHMCS Client Area, you’ll need to enable the option (on a per domain basis) via Wholesale System > Manage (or search for the domain) > Name Servers > Click Email/URL Forwarding or DNS Hosting (depending on what you require).

@@ Line 19: / Line 19: @@
 # Login to your WHMCS Admin Area
-# Navigate to Setup > Products/Services > Domain Registrars
+# Navigate 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'''.
 # Locate Ventraip in the list
 # Click the '''Activate''' button
@@ Line 52: / Line 52: @@
 After you have verified you are running the latest version of the WHMCS module, and applied the configuration changes required in the Wholesale System, you will need to configure and enable the module through WHMCS.
-Begin by going to WHMCS Setup > Product/Services > Domain Registrars. Scroll down the page until you find ‘Ventraip’, click Activate and then Configure to modify the settings in the module.
+Begin by going, in WHMCS, 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'''. Scroll down the page until you find ‘Ventraip’, click Activate and then Configure to modify the settings in the module.
 You will need to insert your Reseller ID and API Key, which can be found in the Wholesale System  Your Account > API Information. You will also be presented with an option that will allow you to control how AU domain name transfers & renewals are handled. More information on this function is included below.
@@ Line 76: / Line 76: @@
 ==Automatic Domain Synchronization==
 The VentraIP Wholesale 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 [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system.
+To enable this functionality, you need to ensure you have the '''Domain Sync Enabled''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Domains''' or, prior to WHMCS 8.0, '''Setup > General Settings > Domains'''. Ensure you have the [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system.
 ==Troubleshooting==

← Older revision		Revision as of 22:49, 13 February 2018
Line 1:		Line 1:
−	<div class="errorbox">Please note that the VentraIP module ~~we include is being phased out in favor of their official module, and we recommend using it going forward~~. It can be obtained from https://marketplace.whmcs.com/product/3757	+	<div class="errorbox">Please note that the VentraIP module previously distributed with WHMCS has been deprecated. The replacement can be obtained from https://marketplace.whmcs.com/product/3757
	</div>		</div>

@@ Line 12: / Line 12: @@
 | domainsync = yes
 }}
 ==Activation==

@@ Line 10: / Line 10: @@
 | dnsmanagement = yes
 | emailforwarding = yes
 }}