Difference between revisions of "Heart Internet Domains"

From WHMCS Documentation

Line 1: Line 1:
<div class="docs-alert-info">For documentation for the Heart Internet provisioning module, see [[Heart Internet]].</div>
+
== About this Module ==
  
===Supported Features===
+
<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 11: Line 14:
 
| 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:
  
# Log in 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 '''Activate'''.
 
# 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'''.
 
# Click '''Save Changes'''.
  
<div class="docs-alert-info">
+
=== Test Mode ===
[https://customer.heartinternet.co.uk/manage/api/ Click here] to obtain the API username and password.
 
</div>
 
  
====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.
  
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 set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.
 
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]].
+
To enable automatic registration, see [[Domain Pricing]].
 
 
===Automatic Domain Synchronization===
 
  
The Heart Internet module supports automatic domain synchronization for syncing of expiry dates and status changes for incoming transfers.
+
== Automatic Domain Synchronization ==
  
To use this, enable:
+
This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.
  
* '''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'''.
+
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]]'''.
* The [[Crons#Domain_Sync_Cron|Domain Sync Cron]] on your system.
 
  
 
==Troubleshooting==
 
==Troubleshooting==

Revision as of 21:29, 11 April 2022

About this Module

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 in the Domains tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings. You must also make certain to configure the Domain Sync Cron.

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