Revision as of 16:00, 30 January 2018

Supported Features

Activation

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

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

IP Registration

• VentraIP Wholesale's API is IP restricted.
• Therefore to use the VentraIP Wholesale API, you must first open a ticket with them and request they allow your server IP address access to use your VentraIP Wholesale account via the API.
• You can find the IP you need them to whitelist by navigating to Help > License Information within your WHMCS admin area.

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.

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
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:

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.

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.

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.

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)
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).

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
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

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 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 Domain Sync Cron configured on your system.

Troubleshooting

SoapFault exception: [HTTP] Forbidden in /../modules/registrars/ventraip/ventraip.php:957
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.

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
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.