Difference between revisions of "ENom New TLDs"
From WHMCS Documentation
(→Installation) |
(→About this Addon Module) |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | == About this Addon Module == | |
| − | |||
| − | + | <div class="docs-alert-danger"> | |
| + | Enom's New TLDs addon was removed in WHMCS 8.2. However, this functionality is still available natively through the [[Enom]] module. | ||
| + | </div> | ||
| − | + | [[File:Newtlds3.png|thumb|Client Area Interface]] | |
| − | |||
| − | |||
| − | + | 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]. | |
| − | |||
| − | + | <table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;"> | |
| − | + | <tr> | |
| − | + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th> | |
| − | + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th> | |
| − | + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th> | |
| + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th> | ||
| + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">ENom New TLDs</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">N/A</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">N/A</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">WHMCS 8.1 and earlier</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;color:darkgreen;">Yes</td> | ||
| + | </tr> | ||
| + | </table> | ||
| − | == | + | == Activating ENom New TLDs == |
| − | |||
| − | |||
| − | + | Because this addon ships with WHMCS by default, you only need to activate the addon through the Admin Area. | |
| + | |||
| + | To do this: | ||
| + | |||
| + | # 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 '''Activate''' for '''eNom New TLDs'''. | ||
| + | # Click '''Configure'''. | ||
| + | # Select the admin role groups who will have access to this addon. | ||
| + | # 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. | ||
| + | # Go to '''Addons > Enom New TLDs'''. | ||
| + | # 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 <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.example.com/whmcs/index.php?m=enomnewtlds</nowiki></tt>, where <tt><nowiki>example.com/whmcs</nowiki></tt> is the actual path to your WHMCS installation. | ||
| + | # Click '''Save Changes'''. | ||
| + | For more information, see [[Enom#IP_Registration_.28Registrar_Error_Invalid_Client_IP.29|Enom's documentation]]. | ||
| + | == Template Customisation == | ||
| + | [[File:Newtlds2.png|thumb|Client Area Links]] | ||
| − | + | 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. | |
| − | + | ||
| − | + | === Add Links Manually === | |
| − | |||
| − | |||
| + | If you use a different system theme template, you must add these links manually. | ||
| − | Save changes and upload. | + | To do this: |
| + | |||
| + | # Open the <tt>/templates/your-template-name/clientareahome.tpl</tt> file. | ||
| + | # 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> | ||
| + | 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></nowiki></div> | ||
| + | # Save your changes and upload the file. | ||
| + | # 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> | ||
| + | <a href="index.php?m=enomnewtlds">Preregister New TLDs</a> | ||
| + | </nowiki></div> | ||
| + | # Save your changes and upload the file. | ||
| − | + | == Troubleshooting == | |
| − | + | === 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#IP_Registration_.28Registrar_Error_Invalid_Client_IP.29|Enom's documentation]]. | |
| − | This error | ||
Latest revision as of 14:04, 28 December 2022
Contents
About this Addon Module
Enom's New TLDs addon was removed in WHMCS 8.2. However, this functionality is still available natively through the Enom module.
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.
| Addon Name | Latest Release | Current Version | Compatible With | Included in WHMCS |
|---|---|---|---|---|
| ENom New TLDs | N/A | N/A | WHMCS 8.1 and earlier | Yes |
Activating ENom New TLDs
Because this addon ships with WHMCS by default, you only need to activate the addon through the Admin Area.
To do this:
- Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
- Click Activate for eNom New TLDs.
- Click Configure.
- Select the admin role groups who will have access to this addon.
- 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.
- Go to Addons > Enom New TLDs.
- 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.example.com/whmcs/index.php?m=enomnewtlds, where example.com/whmcs is the actual path to your WHMCS installation.
- Click Save Changes.
For more information, see Enom's documentation.
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.
Add Links Manually
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;"></div> 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.
Troubleshooting
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.