Difference between revisions of "Heart Internet Domains"

From WHMCS Documentation

Line 1: Line 1:
<div class="docs-alert-info">Looking for documentation on the Heart Internet provisioning module? Go to [[Heart Internet]]</div>
+
<div class="docs-alert-info">For documentation for the Heart Internet provisioning module, see [[Heart Internet]].</div>
  
 
===Supported Features===
 
===Supported Features===
 +
 
{{registrar
 
{{registrar
 
| notitle = yes
 
| notitle = yes
Line 12: Line 13:
  
 
===Activation===
 
===Activation===
To activate and begin using the Heart Internet registrar module, follow the steps below:
 
  
# Login to your WHMCS Admin Area
+
To activate and begin using the Heart Internet registrar module:
 +
 
 +
# Log in to your 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'''.
 
# 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 Heart Internet in the list.
+
# Locate '''Heart Internet''' in the list.
# Click the '''Activate''' button.
+
# Click '''Activate'''.
 
# Enter your Heart Internet API credentials.
 
# Enter your Heart Internet API credentials.
# Click Save Changes to complete the process.
+
# Click '''Save Changes'''.
  
<div class="docs-alert-info">The API Username and Password can be obtained from https://customer.heartinternet.co.uk/manage/api/</div>
+
<div class="docs-alert-info">
 +
[https://customer.heartinternet.co.uk/manage/api/ Click here] to obtain the API username and password.
 +
</div>
  
 
====Test Mode====
 
====Test Mode====
WHMCS can be configured for testing purposes by ticking the "TestMode" option when configuring Heart Internet as the registrar. This will point all domain related requests to the test environment provided to you by Heart Internet.
+
 
 +
You can configure WHMCS for testing purposes by checking '''TestMode''' when you configure Heart Internet as the registrar. This will point all domain-related requests to the test environment.
  
 
===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.
 +
 
 +
To enable automatic registration, see [[Domain Pricing|Configuring Automatic Registration]].
  
 
===Automatic Domain Synchronization===
 
===Automatic Domain Synchronization===
 +
 
The Heart Internet module supports automatic domain synchronization for syncing of expiry dates and status changes for incoming transfers.
 
The Heart Internet 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 > 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.
+
To use this, enable:
 +
 
 +
* '''Domain Sync Enabled''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domains''' or, prior to WHMCS 8.0, '''Setup > General Settings > Domains'''.
 +
* The [[Crons#Domain_Sync_Cron|Domain Sync Cron]] on your system.
  
 
==Troubleshooting==
 
==Troubleshooting==
'''Caught exception: Communication failure'''<br>
+
 
Please ensure the following ports are open for outbound connections from your WHMCS server: 700(live) & 1701(test). This error suggests your firewall is blocking connections to HeartInternet and should be opened.
+
=== Caught exception: Communication failure ===
 +
 
 +
This error indicates that your firewall is blocking connections to HeartInternet. Make certain that the following ports are open for outbound connections from your WHMCS server:  
 +
 
 +
* 700(live)  
 +
* 1701(test).

Revision as of 17:57, 10 September 2021

For documentation for the Heart Internet provisioning module, see Heart Internet.

Supported Features

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

Activation

To activate and begin using the Heart Internet registrar module:

  1. Log in to your WHMCS Admin Area.
  2. Navigate to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
  3. Locate Heart Internet in the list.
  4. Click Activate.
  5. Enter your Heart Internet API credentials.
  6. Click Save Changes.

Click here to obtain the API username and password.

Test Mode

You can configure WHMCS for testing purposes by checking TestMode when you configure Heart Internet as the registrar. This will point all domain-related requests to the test environment.

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 Configuring Automatic Registration.

Automatic Domain Synchronization

The Heart Internet module supports automatic domain synchronization for syncing of expiry dates and status changes for incoming transfers.

To use this, enable:

  • Domain Sync Enabled in Configuration () > System Settings > Domains or, prior to WHMCS 8.0, Setup > General Settings > Domains.
  • The Domain Sync Cron on your system.

Troubleshooting

Caught exception: Communication failure

This error indicates that your firewall is blocking connections to HeartInternet. Make certain that the following ports are open for outbound connections from your WHMCS server:

  • 700(live)
  • 1701(test).