ENom New TLDs

From WHMCS Documentation

Revision as of 03:15, 12 December 2014 by John (talk | contribs) (Installation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Client Area Interface

This addon allows your customers to participate in the launch of new TLDs. Customers can build Watchlists to keep updated on new TLDs or specific domain names. As new TLDs launch, they can place orders and you earn commissions from their Watchlist on each launch phase including: Sunrise, Landrush, and Pre-Registration.

Once activated, you can customize which launch phases and new TLDs are offered via your reseller account at eNom.com. This addon requires an eNom reseller account to function. If you don't already have an account with Enom, you can signup for the free account we offer to all clients here!

Installation

Navigate to Setup > Addon Modules and click the green Activate button next to the eNom New TLDs module. Once enabled, click Configure and select the user groups that can have access to the configuration, usually just the Full Administrator option.

Login to your eNom account and open a support ticket to the API category. Include your server's IP address so access to the eNom API can be granted. If you've already done this for the regular eNom module, then you do not need to repeat this step. More information is available here.

Configuration

Configuration Screen

Once activated, navigate to Addons > eNom New TLDs and complete the configuration fields:

  • eNom LoginID - Your eNom account's username
  • eNom Password - Your eNom account's password
  • Company Name - Your company's name
  • Support Email Address - The "Reply To" address for emails sent by eNom to your clients regarding domains they are watching. This should be the email of your support department.
  • Default URL for New TLDs Addon - This field specifies the URL clients use to access the addon. This should be http://www.yourdomain.com/whmcs/index.php?m=enomnewtlds (replace yourdomain.com/whmcs with the actual path to your WHMCS installation).

Template Customisation

Client Area Links

If using the default template then links to the addon will appear within the client area automatically upon activation; a link under the "My Domains" menu item and a promotional image on the client area homepage.

If using a different or custom template it is necessary to add these links manually. Open the /templates/*your active template*/clientareahome.tpl file and add:



<div style="background:#0064CD;background:-moz-linear-gradient(top, #0064CD 0%, #207ce5 100%);background:-webkit-linear-gradient(top, #0064CD 0%,#207ce5 100%);background:-ms-linear-gradient(top, #0064CD 0%,#207ce5 100%);background:linear-gradient(to bottom, #0064CD 0%,#207ce5 100%);border:1px solid #0972E2;color:#FFF;font-family:Trebuchet MS, Trebuchet MS, sans-serif;font-size:18px;text-align:center;margin:24px 0;padding:14px;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px;-webkit-box-shadow:0 5px 5px -3px rgba(0,0,0,0.3);-moz-box-shadow:0 5px 5px -3px rgba(0,0,0,0.3);box-shadow:0 5px 5px -3px rgba(0,0,0,0.3);zoom:1;">
The next generation of domains is coming! Take advantage of New TLD opportunities. <a href="/index.php?m=enomnewtlds" style="color:#FFD20A">Learn More »</a>
</div>


Save changes and upload.

Next open the /templates/*your active template*/header.tpl file and add:

<a href="index.php?m=enomnewtlds">Preregister New TLDs</a>

Save changes and upload.

Common Errors

Portal type is not allowed to change unless it is in draft mode

This error means the eNom account has been configured to use a different integration method for the New TLDs system such as storefront or widget. In order to use WHMCS you must contact eNom technical support in order to have the new TLD portal reset to draft mode.

User not permitted from this IP address

This error means your server's IP address is not whitelisted for access to eNom API. You must open a support ticket with their AI department to request access. More information is available here.