Difference between revisions of "Heart Internet"
(→Information) |
|||
| Line 4: | Line 4: | ||
| clientarealink = Yes | | clientarealink = Yes | ||
| port = 700(live) & 1701(test)}} | | port = 700(live) & 1701(test)}} | ||
| + | |||
==Information== | ==Information== | ||
Heart Internet is a UK based reseller web hosting and domain name provider and in WHMCS we have modules for both their '''hosting and domain reseller API's'''. | Heart Internet is a UK based reseller web hosting and domain name provider and in WHMCS we have modules for both their '''hosting and domain reseller API's'''. | ||
==Hosting Module== | ==Hosting Module== | ||
| − | |||
===Supported Functionality=== | ===Supported Functionality=== | ||
| − | |||
*Account Creation | *Account Creation | ||
*Suspension | *Suspension | ||
| Line 20: | Line 19: | ||
===Package Setup/Configuration=== | ===Package Setup/Configuration=== | ||
| − | |||
Begin by going to '''Setup > Products/Services > Servers''' and adding a new server. The name can be anything you want, the module must be set as "Heartinternet" and your Username & Password for Heart's API (which can be obtained from https://customer.heartinternet.co.uk/manage/api) needs to be entered into the appropriate fields. The other fields of the server profile are all optional. | Begin by going to '''Setup > Products/Services > Servers''' and adding a new server. The name can be anything you want, the module must be set as "Heartinternet" and your Username & Password for Heart's API (which can be obtained from https://customer.heartinternet.co.uk/manage/api) needs to be entered into the appropriate fields. The other fields of the server profile are all optional. | ||
| Line 28: | Line 26: | ||
==Domain Registrar Module== | ==Domain Registrar Module== | ||
| − | + | ===Supported Features=== | |
| − | ===Supported | ||
{{registrar | {{registrar | ||
| notitle = yes | | notitle = yes | ||
| Line 39: | Line 36: | ||
}} | }} | ||
| − | ===Setup/ | + | ===Activation=== |
| + | To activate and begin using the Heart Internet registrar module, follow the steps below: | ||
| + | |||
| + | # Login to your WHMCS Admin Area | ||
| + | # Navigate to Setup > Products/Services > Domain Registrars | ||
| + | # Locate Heart Internet in the list | ||
| + | # Click the '''Activate''' button | ||
| + | # Enter your Heart Internet API credentials | ||
| + | # Click Save Changes to complete the process | ||
| + | |||
| + | <div class="docs-alert-info">The API Username & Password can be obtained from https://customer.heartinternet.co.uk/manage/api/</div> | ||
| + | |||
| + | ====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. | ||
| − | + | ===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]] | |
| + | ===Automatic Domain Synchronization=== | ||
| + | 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 Setup > General Settings > Domains and ensure you have the [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system. | |
| − | |||
| − | |||
| − | |||
| − | + | ==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. | ||
Revision as of 15:49, 30 January 2018
Contents
Supported Features
| Create | Suspend | Unsuspend | Terminate |
|---|---|---|---|
| Yes | Yes | Yes | Yes |
| Change Package | Change Password | Usage Updates | Client Area Link |
|---|---|---|---|
| Yes | Yes | No | Yes |
The following ports should be open for outbound connections from your WHMCS server: 700(live) & 1701(test)
Information
Heart Internet is a UK based reseller web hosting and domain name provider and in WHMCS we have modules for both their hosting and domain reseller API's.
Hosting Module
Supported Functionality
- Account Creation
- Suspension
- Unsuspension
- Account Termination
- Automatic Upgrades/Downgrades
- Password Resets (from Client & Admin Area)
- Automatic Login
Package Setup/Configuration
Begin by going to Setup > Products/Services > Servers and adding a new server. The name can be anything you want, the module must be set as "Heartinternet" and your Username & Password for Heart's API (which can be obtained from https://customer.heartinternet.co.uk/manage/api) needs to be entered into the appropriate fields. The other fields of the server profile are all optional.
Next it's onto the products. If you already have your packages setup then just edit those to add the Heart settings, but if not then create a new product in the normal way from Setup > Products/Services, and then on the Module Settings tab select "Heartinternet" from the dropdown. There you'll find 2 fields - Test Mode & Package ID. Enter the Package ID which should be a value you can get from inside your heart control panel and then select the automation setting you want for orders of this item (ie. auto setup on first payment, or only after accepting the pending order, etc..) then save.
Now try a test order to check everything is ok. If setup of the hosting account fails for any reason and the account remains pending, check in Utilities > Activity Log for any errors returned from the API.
Domain Registrar Module
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, follow the steps below:
- Login to your WHMCS Admin Area
- Navigate to Setup > Products/Services > Domain Registrars
- Locate Heart Internet in the list
- Click the Activate button
- Enter your Heart Internet API credentials
- Click Save Changes to complete the process
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.
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 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 Setup > General Settings > Domains and ensure you have the Domain Sync Cron configured on your system.
Troubleshooting
Caught exception: Communication failure
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.