Difference between revisions of "HEXONET"

Latest revision as of 12:18, 7 June 2023

About this Module

We added this module in WHMCS 7.7.

The HEXONET module allows you to register and manage domains with HEXONET.

Supported Features

Register	Transfer	Renew	Registrar Lock
Yes	Yes	Yes	Yes
Update Nameservers	Update WHOIS	Get EPP Code	Register Nameservers
Yes	Yes	Yes	Yes
DNS Record Management	Email Forwarding	Domain Release	Domain Sync Script
Yes	Yes	Yes	Yes
Premium Domains	Transfer Out Automation	TLD Pricing Sync
Yes	Yes	No

Activation

To activate and begin using the HEXONET registrar module:

Log in to the WHMCS Admin Area.
Go to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
Find HEXONET in the list.
Click Activate.
Enter your HEXONET credentials and configuration.
- For help with using a proxy server, see HEXONET's documentation.
- By default, the HEXONET API converts domains to IDN format (recommended). Change this to PHP to make use of the idn_to_ascii function (deprecated). This function must be compiled in your php.ini file.
- Check DNSSEC to display the DNSSEC configuration interface in the Client Area domain details page. This feature allows your customer to add DS and KEY records and set the maxSigLife setting.
- Check TRANSFERLOCK to automatically apply the transfer lock to new domain registrations.
Click Save Changes.
Log in to the HEXONET control panel.

Renewal Mode Setting
Go to Products > Domain Name Settings. Click + More and search for it if you do not see it in the list.
For Renewal Mode For New Domains, select Expire Domain. If you do not do this, domains might be renewed without payment from the client.
Click Save.

IP Registration

HEXONET's API is not IP address-restricted by default. However, you can configure this restriction in the control panel to improve security.

To do this:

Log in to HEXONET.
Click on your username in the upper-right corner.
Navigate to Settings > Security > IP Restrictions.
Enter your server's IP address.
Click Save Changes.

You can find the IP address to whitelist at Help > License Information in the WHMCS Admin Area.

Test Mode

You can use test mode to simulate domain registration and management function without registering a domain or incurring charges. This can be useful to test WHMCS configurations.

To use Test Mode, you must create a HEXONET test account.

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

Disconnected / Authorization Failed

Common causes for a Disconnected or Authorization Failed error are:

An incorrect password or username in the registrar module settings at Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
Two-Factor authentication is enabled for the user in your HEXONET account. This can be resolved by deactivating it for your HEXONET user or creating a restricted user role and new user that WHMCS will use to connect to HEXONET's API.
IP address restriction settings in your HEXONET account do not allow your WHMCS server to connect to the HEXONET API.
Your server firewall is blocking the connection.
You are connecting to the test environment using your HEXONET production account or vice versa. The HEXONET OTE API uses a different set of login credentials than the production environment.

Empty response from API

This can occur when the API endpoint is unreachable. You can test this by running the ping api.ispapi.net command from the WHMCS server's command line.

The module uses ports 80 and 443 to connect to HEXONET over HTTP. Make sure that these ports are whitelisted in your server firewall.

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

@@ Line 1: / Line 1: @@
+== About this Module ==
+<div class="docs-alert-success">
+We added this module in WHMCS 7.7.
+</div>
+The HEXONET module allows you to register and manage domains with HEXONET.
 {{registrar
 | register = yes
@@ Line 15: / Line 22: @@
 | transferout = yes
 }}
-<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.7 and above</div>
 ==Activation==
-To activate and begin using the HEXONET registrar module, follow the steps below:
-# Login to your WHMCS Admin Area
+To activate and begin using the HEXONET registrar module:
-# Navigate to Setup > Products/Services > Domain Registrars
-# Locate HEXONET in the list
-# Click the '''Activate''' button
-# Enter your HEXONET account username
-# Enter your HEXONET account password
-# Click Save Changes to complete the process
-<div class="docs-alert-info">
+# Log in to the WHMCS Admin Area.
-<span class="title">Auto Renewal</span><br />
+# 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'''.
-Configure the default domain renewal mode to AUTOEXPIRE in your HEXONET Control Panel, otherwise domains might be renewed without being paid by the customer in WHMCS
+# Find '''HEXONET''' in the list.
-</div>[[File:Hexonet renewal mode.png|thumb|Renewal Mode Setting]]
+# Click '''Activate'''.
+# Enter your HEXONET credentials and configuration.
+#* For help with using a proxy server, see [https://wiki.hexonet.net/wiki/HighPerformanceProxySetup HEXONET's documentation].
+#* By default, the HEXONET API converts domains to IDN format (recommended). Change this to PHP to make use of the <tt>idn_to_ascii</tt> function (deprecated). This function [http://php.net/manual/en/function.idn-to-ascii.php must be compiled] in your <tt>php.ini</tt> file.
+#* Check '''DNSSEC''' to display the DNSSEC configuration interface in the Client Area domain details page. This feature allows your customer to add DS and KEY records and set the <tt>maxSigLife</tt> setting.
+#* Check '''TRANSFERLOCK''' to automatically apply the transfer lock to new domain registrations.
+# Click '''Save Changes'''.
+# Log in to the HEXONET control panel. [[File:Hexonet renewal mode.png|thumb|Renewal Mode Setting]]
+# Go to '''Products > Domain Name Settings'''. Click '''+ More''' and search for it if you do not see it in the list.
+# For '''Renewal Mode For New Domains''', select '''Expire Domain'''. If you do not do this, domains might be renewed without payment from the client.
+# Click '''Save'''.
-#Login to the HEXONET Control Panel
+===IP Registration===
-#Navigate to '''Products > Domain Name Settings'''
-#* Use ''+ More'' if that menu entry is not available and search for it in that list
-#In the ''Renewal Mode For New Domains'' setting, select the ''Expire Domain'' option
-#Click Save
-===IP Registration===
+HEXONET's API is '''not''' IP address-restricted by default. However, you can configure this restriction in the control panel to improve security.
-HEXONET's API is '''not''' IP restricted by default, but can be configured in that direction to improve security. This can be done in the HEXONET control panel.
-# Login to the HEXONET control panel
-# Click on your username in the upper right
-# Navigate to '''Settings > Security > IP Restrictions'''
-# Enter your server's IP address
-# Save Changes
-You can find the IP you need to whitelist by navigating to '''Help > License Information''' within your WHMCS admin area
-===Test Mode===
+To do this:
-The HEXONET's OT&E (Operational Test & Evaluation) system permits testing of domain registration and management actions without actually registering domains so no charges are incurred. To use it:
-#[https://www.hexonet.net/signup-ote Create an test account here]<br/>
-#In WHMCS enter your HEXONET test account username and password
-#Tick the ''TestMode'' checkbox
-#Click ''Save Changes''
-To return to live mode, enter your live HEXONET username and password into the WHMCS Domain Registrars page and untick the TestMode option.
+# Log in to HEXONET.
+# Click on your username in the upper-right corner.
+# Navigate to '''Settings > Security > IP Restrictions'''.
+# Enter your server's IP address.
+# Click '''Save Changes'''.
-===ProxyServer===
+You can find the IP address to whitelist at '''Help > [[License Information]]''' in the WHMCS Admin Area.
-Whilst optional, you can enter the URL of your proxy server, instructions for configuring a proxy server are located at https://wiki.hexonet.net/wiki/HighPerformanceProxySetup
-===IDN Configuration===
+===Test Mode===
-By default the HEXONET API is used to convert domains to IDN format (recommended).  Change to PHP to make use of the idn_to_ascii function can be made to handle conversion instead (deprecated). This function must be compiled in your php.ini to operate: http://php.net/manual/en/function.idn-to-ascii.php
-===DNSSEC===
+You can use test mode to simulate domain registration and management function without registering a domain or incurring charges. This can be useful to test WHMCS configurations.
-This can be enabled to display the DNSSEC configuration interface in the client area domain details page. This feature allows your customer to add DS and KEY records and set the maxSigLife.
-===TRANSFERLOCK===
+To use Test Mode, you must create a [https://www.hexonet.net/signup-ote HEXONET test account].
-Enable to automatically apply the transfer lock to new domain registrations.
-==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 HEXONET 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.
+== 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'''.
-==Troubleshooting==
+== Troubleshooting ==
 ===Disconnected / Authorization Failed===
-Common causes for a 'Disconnected' or 'Authorization Failed' error are :
+Common causes for a ''Disconnected'' or ''Authorization Failed'' error are:
-# Incorrect password and/or username in the Registrar module settings (Setup > Products/Services > Domain Registrars > "Configure")
+* An incorrect password or username in the registrar module settings at '''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'''.
-# Two-Factor authentication is enabled for the user in your HEXONET account. This can be resolved by deactivating Two-Factor for your HEXONET user, or creating a restricted user role and new user which WHMCS will use to connect to HEXONET's API.
+* Two-Factor authentication is enabled for the user in your HEXONET account. This can be resolved by deactivating it for your HEXONET user or creating a restricted user role and new user that WHMCS will use to connect to HEXONET's API.
-# IP Restriction Settings in your HEXONET account do not allow connections from your WHMCS Server to the HEXONET API
+* IP address restriction settings in your HEXONET account do not allow your WHMCS server to connect to the HEXONET API.
-# Your server firewall is blocking the connection
+* Your server firewall is blocking the connection.
-# You are connecting to the Test Environment using your HEXONET production account or vice versa. The HEXONET OTE API uses a different set of login credentials to the production environment.
+* You are connecting to the test environment using your HEXONET production account or vice versa. The HEXONET OTE API uses a different set of login credentials than the production environment.
 ===Empty response from API===
+This can occur when the API endpoint is unreachable. You can test this by running the <tt>ping api.ispapi.net</tt> command from the WHMCS server's command line.
-This can occur in case the API endpoint is unreachable. You can test this by trying to ping `api.ispapi.net` from your WHMCS server command line.
+The module uses ports <tt>80</tt> and <tt>443</tt> to connect to HEXONET over HTTP. Make sure that these ports are whitelisted in your server firewall.
-The module uses ports 80 & 443 to connect to HEXONET over HTTP. You will want to ensure these ports are whitelisted in your server firewall.
 {{modules}}

Documentation