Difference between revisions of "Heart Internet Domains"

From WHMCS Documentation

(About this Module)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<div class="docs-alert-info">Looking for documentation on the Heart Internet provisioning module? Go to [[Heart Internet]]</div>
+
== About this Module ==
  
===Supported Features===
+
<div class="docs-alert-info">
 +
We removed this module in WHMCS 8.8. Heart Internet discontinued support for its API in February 2023. As a result, this module no longer functions on any version of WHMCS.
 +
</div>
 +
 
 +
<div class="docs-alert-info">
 +
For documentation for the Heart Internet provisioning module, see [[Heart Internet]].
 +
</div>
 +
 
 +
The Heart Internet Domains module allows you to register and manage domains with Heart Internet.
 
{{registrar
 
{{registrar
 
| notitle = yes
 
| notitle = yes
Line 10: Line 18:
 
| domainsync = yes
 
| domainsync = yes
 
}}
 
}}
 +
===Activation===
  
===Activation===
+
To activate and begin using the Heart Internet registrar module:
To activate and begin using the Heart Internet registrar module, follow the steps below:
 
  
# Login to your WHMCS Admin Area
+
# 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'''.
# Locate Heart Internet in the list.
+
# Find '''Heart Internet''' in the list.
# Click the '''Activate''' button.
+
# Click '''Activate'''.
# Enter your Heart Internet API credentials.
+
# Enter your Heart Internet credentials. You can find them when you log in [https://customer.heartinternet.co.uk/manage/api/ here].
# 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>
+
=== Test Mode ===
  
====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.
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.
 
  
===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 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.
+
== 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==
'''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).

Latest revision as of 17:10, 28 August 2023

About this Module

We removed this module in WHMCS 8.8. Heart Internet discontinued support for its API in February 2023. As a result, this module no longer functions on any version of WHMCS.

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

The Heart Internet Domains module allows you to register and manage domains with Heart Internet.


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 the WHMCS Admin Area.
  2. Go to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
  3. Find Heart Internet in the list.
  4. Click Activate.
  5. Enter your Heart Internet credentials. You can find them when you log in here.
  6. Click Save Changes.

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.

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

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