Difference between revisions of "Enom"

From WHMCS Documentation

(→‎Activation)
(→‎Automatic Domain Synchronization)
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
== About this Module ==
 +
 +
The Enom module allows you to register and manage domains with Enom.
 
{{registrar
 
{{registrar
 
| register = yes
 
| register = yes
Line 13: Line 16:
 
| premium = yes
 
| premium = yes
 
| transferout = yes
 
| transferout = yes
 +
| tldpricingsync = yes
 
}}
 
}}
  
 
==Activation==
 
==Activation==
 +
 
<div class="docs-alert-success">
 
<div class="docs-alert-success">
−
<span class="title">Don't have an Enom account yet?</span><br />
+
You must create an [https://www.whmcs.com/partners/enom/ Enom account].
−
Get one here: https://www.whmcs.com/partners/enom/
 
 
</div>
 
</div>
  
−
To activate and begin using the Enom registrar module, follow the steps below:
+
To activate and begin using the Enom registrar module:
 +
 
 +
# Log in to your account on the [https://www.enom.com/apitokens/default.aspx Enom website].
 +
# Enter an identifying name in the textbox (for example, <tt>WHMCS</tt>).
 +
# Click '''Generate New API Token'''.
 +
# Copy the generated API token.
 +
# Log in to the WHMCS Admin Area.
 +
# 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'''.
 +
# Find '''Enom''' in the list.
 +
# Click '''Activate'''.
 +
# Enter your Enom username.
 +
# Paste in the API token.
 +
# Check '''Disable IRTP''' to prevent WHMCS from displaying contact information verification notices.
 +
# Check '''Use Default Nameservers''' to use Enom's default nameservers for new registrations, overriding the nameservers in WHMCS.
 +
# Click '''Save Changes'''.
 +
# In your Enom account, go to '''Resellers > Manage > API''' and add your server's IP address.
 +
#* You can find this address in WHMCS at '''Help > [[License Information]]'''.
 +
#* If you do not do this, you will see a '''Registrar Error Invalid Client IP''' error.
  
−
# Login to your account on the [https://www.enom.com/apitokens/default.aspx Enom website]
+
<html><a href="http://www.youtube.com/watch?v=0Sz9mkBzLN0&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span>&nbsp;<img src="https://assets.whmcs.com/icons/youtube.png">&nbsp;</span></a></html>
−
# The text field, enter an identifying name (eg. WHMCS)
+
<div class="docs-alert-warning">Before you can begin using the Enom API with your account. you must authorize your server IP address for access to your account. See below for steps to do this.</div>
−
# Click ''Generate New API Token''
 
−
# Copy the API token which is created
 
−
# Login to your WHMCS Admin Area
 
−
# Navigate to Setup > Products/Services > Domain Registrars
 
−
# Locate Enom in the list
 
−
# Click the '''Activate''' button
 
−
# Enter your Enom username and API Token
 
−
# Click Save Changes to complete the process
 
  
−
<br>[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=0Sz9mkBzLN0&hd=1|Watch Video Tutorial]]
+
=== Test Mode ===
−
<div class="docs-alert-warning">Before you can begin using the Enom API with your account you must authorize your server IP for access to your account. See below for steps to do this.</div>
 
  
−
===IP Registration===
+
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.
−
In order to use the Enom API, you must first register your server IP address with them to authorize it to access your account (the server IP address where you have WHMCS installed). This is a security measure employed by Enom to prevent unauthorised users being able to submit registration requests to your account.
 
  
−
* Login to your account on the [https://www.enom.com/resellers/reseller-account.aspx Enom website]
+
Before you enable '''Test Mode''' in WHMCS, you must register on Enom's Reseller Test environment:
−
* Navigate to '''Resellers > Manage > API'''
 
−
* Enter your server's IP address into the "New" field
 
−
* Click "Add"
 
  
−
<div class="docs-alert-info">Failure to do this will result in you seeing the error message, "Registrar Error Invalid Client IP"</div>
+
# Log in to [https://resellertest.enom.com/resellers/reseller-testaccount.aspx Enom's Reseller Test Account].
 +
# Click all three links under '''Test Interface Options''' to configure the test account.
 +
# [https://resellertest.enom.com/apitokens/default.aspx Generate a test API token.]
  
−
===Test Mode===
+
When you place domain registration orders in WHMCS with test mode active, the domains will appear on your demo Enom account (<tt>http://resellertest.enom.com</tt>) but no domain will actually be registered and you will not be charged.
−
To use the Enom test mode, it's not as simple as ticking the test mode option in the configuration area. You must setup an account separately on the dedicated demo system they offer. In your Enom account navigate to Resellers > API > Test Account and click all three links under "Test Interface Options": http://www.enom.com/resellers/ResellerTestAccount.asp
 
  
−
With the Test Mode checkbox ticked you can now place domain registration orders in WHMCS, the domains will appear on your demo Enom account @ http://resellertest.enom.com but no domain will actually be registered and you will not be charged.
+
=== .ca Registrations ===
  
−
===.ca Registrations===
+
<tt>.ca</tt> registrations require additional fields. The <tt>Invalid registrant information</tt> error is due to problems with the location field.  
−
.ca Registrations require additional fields. A common error "Invalid registrant information" is caused by the location field. Instead of entering the full place name you should use one of the following province abbreviations:
 
  
−
* Alberta - AB
+
Instead of entering the full place name, use one of the following province abbreviations:
−
* British Columbia - BC   
+
 
−
* Manitoba - MB   
+
* Alberta — <tt>AB</tt>
−
* New Brunswick - NB   
+
* British Columbia — <tt>BC</tt>  
−
* Newfoundland and Labrador - NL   
+
* Manitoba — <tt>MB</tt>  
−
* Northwest Territories - NT   
+
* New Brunswick — <tt>NB</tt>  
−
* Nova Scotia - NS   
+
* Newfoundland and Labrador — <tt>NL</tt>  
−
* Nunavut - NU   
+
* Northwest Territories — <tt>NT</tt>  
−
* Ontario - ON   
+
* Nova Scotia — <tt>NS</tt>  
−
* Prince Edward Island - PE   
+
* Nunavut — <tt>NU</tt>  
−
* Quebec - QC   
+
* Ontario — <tt>ON</tt>  
−
* Saskatchewan - SK   
+
* Prince Edward Island — <tt>PE</tt>  
−
* Yukon - YT
+
* Quebec — <tt>QC</tt>  
 +
* Saskatchewan — <tt>SK</tt>  
 +
* Yukon — <tt>YT</tt>
 +
 
 +
== Transfer Pricing ==
  
−
===Transfer Pricing===
 
 
Enom does not allow a domain's registration term to be defined when transferring a domain name.
 
Enom does not allow a domain's registration term to be defined when transferring a domain name.
 
   
 
   
−
When configuring pricing for TLDs to be transferred using Enom, only configure a 1 year transfer price. All other transfer prices can be set to "-1.00".
+
When configuring pricing for TLDs to transfer using Enom, only configure a one year transfer price. Set all other transfer prices to <tt>-1.00</tt>.
  
−
==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 eNom 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 ==
  
−
'''User not permitted from this IP address'''<br>
+
=== User not permitted from this IP address ===
−
This error message indicates that you haven't yet allowed your server's IP to [[#IP Registration (User not permitted from this IP address)|access your Enom account via the API]]. This must be done via the eNom website before you can use the integration.
+
 
 +
This error message indicates that you haven't yet allowed your server's IP to [[#Activation|access your Enom account via the API]] as described in step 14 above. This must be done via the Enom website before you can use the integration.
  
 
The IP you need to authorize is typically the main shared IP of the server, usually most easily found from the IP your WHMCS license is assigned to, but if you're unsure or neither of those IPs work, then Enom can assist and advise you of the IP they see your connection tests as coming from via a support ticket.
 
The IP you need to authorize is typically the main shared IP of the server, usually most easily found from the IP your WHMCS license is assigned to, but if you're unsure or neither of those IPs work, then Enom can assist and advise you of the IP they see your connection tests as coming from via a support ticket.
  
−
'''Cannot parse empty response from server/Empty data response from server - Please try again later'''<br>
+
=== Cannot parse empty response from server/Empty data response from server - Please try again later ===
 +
 
 
This can occur only if an empty response is received from Enom. This isn't a curl error, but an empty response from the Enom API. This suggests a temporary problem at Enom's end. Trying the command again later should be successful.
 
This can occur only if an empty response is received from Enom. This isn't a curl error, but an empty response from the Enom API. This suggests a temporary problem at Enom's end. Trying the command again later should be successful.
  
−
'''Invalid data response from server - Please try again later'''<br>
+
=== Invalid data response from server - Please try again later ===
 +
 
 
This can occur when an unexpected response occurs; e.g. a 404 error or other non-XML method. This suggests a temporary problem at Enom's end. Trying the command again later should be successful.
 
This can occur when an unexpected response occurs; e.g. a 404 error or other non-XML method. This suggests a temporary problem at Enom's end. Trying the command again later should be successful.
 
   
 
   
−
'''CURL Error'''<br>
+
=== CURL Error ===
−
A standard curl error which indicates a connection issue between your server and Enom's API. Please ensure your server is able to make cURL calls to the following URLs:
+
 
 +
A standard curl error which indicates a connection issue between your server and Enom's API. Make certain that your server is able to make cURL calls to the following URLs:
 
   
 
   
−
Demo Mode: resellertest.enom.com<br/>
+
Demo Mode: <tt>resellertest.enom.com</tt>
−
Live Mode: reseller.enom.com
+
Live Mode: <tt>reseller.enom.com</tt>
 +
 
 +
=== Domain name not found ===
 +
 
 +
This error occurs when the domain does not exist in your Enom account. This message will display when a domain transfer is in progress but will automatically disappear when the transfer is complete.
  
 
{{modules}}
 
{{modules}}

Latest revision as of 12:15, 7 June 2023

About this Module

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

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 No Yes
Premium Domains Transfer Out Automation TLD Pricing Sync
Yes Yes Yes

Activation

You must create an Enom account.

To activate and begin using the Enom registrar module:

  1. Log in to your account on the Enom website.
  2. Enter an identifying name in the textbox (for example, WHMCS).
  3. Click Generate New API Token.
  4. Copy the generated API token.
  5. Log in to the WHMCS Admin Area.
  6. Go to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
  7. Find Enom in the list.
  8. Click Activate.
  9. Enter your Enom username.
  10. Paste in the API token.
  11. Check Disable IRTP to prevent WHMCS from displaying contact information verification notices.
  12. Check Use Default Nameservers to use Enom's default nameservers for new registrations, overriding the nameservers in WHMCS.
  13. Click Save Changes.
  14. In your Enom account, go to Resellers > Manage > API and add your server's IP address.
    • You can find this address in WHMCS at Help > License Information.
    • If you do not do this, you will see a Registrar Error Invalid Client IP error.

Watch the video tutorial for this feature  

Before you can begin using the Enom API with your account. you must authorize your server IP address for access to your account. See below for steps to do this.

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.

Before you enable Test Mode in WHMCS, you must register on Enom's Reseller Test environment:

  1. Log in to Enom's Reseller Test Account.
  2. Click all three links under Test Interface Options to configure the test account.
  3. Generate a test API token.

When you place domain registration orders in WHMCS with test mode active, the domains will appear on your demo Enom account (http://resellertest.enom.com) but no domain will actually be registered and you will not be charged.

.ca Registrations

.ca registrations require additional fields. The Invalid registrant information error is due to problems with the location field.

Instead of entering the full place name, use one of the following province abbreviations:

  • Alberta — AB
  • British Columbia — BC
  • Manitoba — MB
  • New Brunswick — NB
  • Newfoundland and Labrador — NL
  • Northwest Territories — NT
  • Nova Scotia — NS
  • Nunavut — NU
  • Ontario — ON
  • Prince Edward Island — PE
  • Quebec — QC
  • Saskatchewan — SK
  • Yukon — YT

Transfer Pricing

Enom does not allow a domain's registration term to be defined when transferring a domain name.

When configuring pricing for TLDs to transfer using Enom, only configure a one year transfer price. Set all other transfer prices to -1.00.

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

User not permitted from this IP address

This error message indicates that you haven't yet allowed your server's IP to access your Enom account via the API as described in step 14 above. This must be done via the Enom website before you can use the integration.

The IP you need to authorize is typically the main shared IP of the server, usually most easily found from the IP your WHMCS license is assigned to, but if you're unsure or neither of those IPs work, then Enom can assist and advise you of the IP they see your connection tests as coming from via a support ticket.

Cannot parse empty response from server/Empty data response from server - Please try again later

This can occur only if an empty response is received from Enom. This isn't a curl error, but an empty response from the Enom API. This suggests a temporary problem at Enom's end. Trying the command again later should be successful.

Invalid data response from server - Please try again later

This can occur when an unexpected response occurs; e.g. a 404 error or other non-XML method. This suggests a temporary problem at Enom's end. Trying the command again later should be successful.

CURL Error

A standard curl error which indicates a connection issue between your server and Enom's API. Make certain that your server is able to make cURL calls to the following URLs:

Demo Mode: resellertest.enom.com Live Mode: reseller.enom.com

Domain name not found

This error occurs when the domain does not exist in your Enom account. This message will display when a domain transfer is in progress but will automatically disappear when the transfer is complete.

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


Retrieved from "http://3.17.75.209/index.php?title=Enom&oldid=34090"