Difference between revisions of "ENom New TLDs"
From WHMCS Documentation
| Line 1: | Line 1: | ||
[[File:Newtlds3.png|thumb|Client Area Interface]] | [[File:Newtlds3.png|thumb|Client Area Interface]] | ||
| − | This addon allows your customers to participate in the launch of new TLDs. Customers can build | + | This addon allows your customers to participate in the launch of new TLDs. Customers can build watchlists to receive updates on new TLDs or specific domain names. They can place orders as new TLDs become available and you earn commissions on each launch phase, including Sunrise, Landrush, and Pre-Registration. |
| − | + | * After activation, you can customize which launch phases and new TLDs to offer via your reseller account at eNom.com. | |
| + | * This addon requires an eNom reseller account. If you don't already have an account with Enom, you can sign up for the free account we offer to all clients [http://www.whmcs.com/enom.php here]. | ||
<div class="docs-alert-info"> | <div class="docs-alert-info"> | ||
| − | Enom's New TLDs addon was removed in WHMCS 8.2. | + | Enom's New TLDs addon was removed in WHMCS 8.2. However, this functionality is still available natively through the Enom module. |
| − | |||
| − | |||
</div> | </div> | ||
==Installation== | ==Installation== | ||
| − | |||
| − | |||
| − | + | To install this addon: | |
| + | # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. | ||
| + | # Click the green '''Activate''' button next to the eNom New TLDs module. | ||
| + | # Click '''Configure'''. | ||
| + | # Select the user groups that can have access to the configuration. Normally, this only requires ''Full Administrator''. | ||
| + | # Log in to your eNom account. | ||
| + | # Open a support ticket to the API category. Make certain that you include your server's IP address to gain access to the eNom API. If you've already done this for the regular eNom module, then you do not need to repeat this step. | ||
| + | |||
| + | For more information, see [[Enom#IP_Registration_.28Registrar_Error_Invalid_Client_IP.29|Enom's documentation]]. | ||
==Configuration== | ==Configuration== | ||
| + | |||
[[File:Newtlds1.png|thumb|Configuration Screen]] | [[File:Newtlds1.png|thumb|Configuration Screen]] | ||
| − | |||
| − | *''' | + | After installation and activation, go to '''Addons > Enom New TLDs''' and complete the following configuration fields: |
| − | *''' | + | |
| − | *'''Company Name''' | + | * '''Enom LoginID''' — Your eNom account's username. |
| − | *'''Support Email Address''' | + | * '''Enom Password''' — Your eNom account's password. |
| − | *'''Default URL for New TLDs Addon''' | + | * '''Company Name''' — Your company's name. |
| + | * '''Support Email Address''' — The <tt>Reply To</tt> address for emails from Enom to your clients regarding domains they are watching. Enter the email address of your support department. | ||
| + | * '''Default URL for New TLDs Addon''' — This field sets the URL clients use to access the addon. This should be <tt><nowiki>http://www.yourdomain.com/whmcs/index.php?m=enomnewtlds</nowiki></tt>, where <tt><nowiki>yourdomain.com/whmcs</nowiki></tt> is the actual path to your WHMCS installation. | ||
==Template Customisation== | ==Template Customisation== | ||
| + | |||
[[File:Newtlds2.png|thumb|Client Area Links]] | [[File:Newtlds2.png|thumb|Client Area Links]] | ||
| − | If you use the default system theme template, links to the addon will appear | + | |
| + | If you use the default system theme template, links to the addon will appear in the Client Area automatically. This includes a link under '''My Domains''' and a promotional image on the Client Area homepage. | ||
| − | If you use a different | + | If you use a different system theme template, you must add these links manually. To do this: |
| − | # Open the <tt>/templates/your-template-name/clientareahome.tpl</tt> file | + | # Open the <tt>/templates/your-template-name/clientareahome.tpl</tt> file. |
| − | <div class="source-cli"> | + | # Add the following code to the file:<div class="source-cli"><nowiki> |
<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;"> | <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> | 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> | + | </div></nowiki> |
</div> | </div> | ||
# Save your changes and upload the file. | # Save your changes and upload the file. | ||
| − | # Open the <tt>/templates/ | + | # Open the <tt>/templates/template-name/header.tpl</tt> file, where <tt>template-name</tt> is your active template, and add:<div class="source-cli"><nowiki> |
| − | <div class="source-cli"> | ||
<a href="index.php?m=enomnewtlds">Preregister New TLDs</a> | <a href="index.php?m=enomnewtlds">Preregister New TLDs</a> | ||
| − | </div> | + | </nowiki></div> |
# Save your changes and upload the file. | # Save your changes and upload the file. | ||
==Common Errors== | ==Common Errors== | ||
===Portal type is not allowed to change unless it is in draft mode=== | ===Portal type is not allowed to change unless it is in draft mode=== | ||
| − | This error | + | This error indicates that the Enom account uses a different integration method for the New TLDs system (for example, a storefront or widget). In order to use WHMCS, you must contact Enom technical support in order to reset the new TLD portal to draft mode. |
===User not permitted from this IP address=== | ===User not permitted from this IP address=== | ||
| − | This error | + | This error indicates that your server's IP address is not whitelisted for access to Enom API. Open a support ticket with their AI department to request access. For more information, see [[Enom#IP_Registration_.28Registrar_Error_Invalid_Client_IP.29|Enom's documentation]]. |
Revision as of 14:19, 30 September 2021
This addon allows your customers to participate in the launch of new TLDs. Customers can build watchlists to receive updates on new TLDs or specific domain names. They can place orders as new TLDs become available and you earn commissions on each launch phase, including Sunrise, Landrush, and Pre-Registration.
- After activation, you can customize which launch phases and new TLDs to offer via your reseller account at eNom.com.
- This addon requires an eNom reseller account. If you don't already have an account with Enom, you can sign up for the free account we offer to all clients here.
Enom's New TLDs addon was removed in WHMCS 8.2. However, this functionality is still available natively through the Enom module.
Contents
Installation
To install this addon:
- Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
- Click the green Activate button next to the eNom New TLDs module.
- Click Configure.
- Select the user groups that can have access to the configuration. Normally, this only requires Full Administrator.
- Log in to your eNom account.
- Open a support ticket to the API category. Make certain that you include your server's IP address to gain access to the eNom API. If you've already done this for the regular eNom module, then you do not need to repeat this step.
For more information, see Enom's documentation.
Configuration
After installation and activation, go to Addons > Enom New TLDs and complete the following 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 from Enom to your clients regarding domains they are watching. Enter the email address of your support department.
- Default URL for New TLDs Addon — This field sets the URL clients use to access the addon. This should be http://www.yourdomain.com/whmcs/index.php?m=enomnewtlds, where yourdomain.com/whmcs is the actual path to your WHMCS installation.
Template Customisation
If you use the default system theme template, links to the addon will appear in the Client Area automatically. This includes a link under My Domains and a promotional image on the Client Area homepage.
If you use a different system theme template, you must add these links manually. To do this:
- Open the /templates/your-template-name/clientareahome.tpl file.
- Add the following code to the file:<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 your changes and upload the file.
- Open the /templates/template-name/header.tpl file, where template-name is your active template, and add:<a href="index.php?m=enomnewtlds">Preregister New TLDs</a>
- Save your changes and upload the file.
Common Errors
Portal type is not allowed to change unless it is in draft mode
This error indicates that the Enom account uses a different integration method for the New TLDs system (for example, a storefront or widget). In order to use WHMCS, you must contact Enom technical support in order to reset the new TLD portal to draft mode.
User not permitted from this IP address
This error indicates that your server's IP address is not whitelisted for access to Enom API. Open a support ticket with their AI department to request access. For more information, see Enom's documentation.