Difference between revisions of "Namecheap"

From WHMCS Documentation

Line 12: Line 12:
 
}}
 
}}
  
==IP Registration (Registrar Error Invalid Client IP)==
+
==Activation==
 +
To activate and begin using the Namecheap registrar module, follow the steps below:
  
*In order to use the Namecheap API, you must first contact them and let them know the server IP address where you will be connecting from (the server IP address where you have WHMCS installed)
+
# Login to your WHMCS Admin Area
*This is part of Namecheap's security measures to prevent unauthorised users being able to submit registration requests to your account.
+
# Navigate to Setup > Products/Services > Domain Registrars
*You can do this by opening a ticket with Namecheap directly asking for your server IP address to be authorized for access to your account
+
# Locate Namecheap in the list
 +
# Click the '''Activate''' button
 +
# Enter your Namecheap API credentials
 +
# Click Save Changes to complete the process
 +
 
 +
<div class="docs-alert-warning">Before you can begin using the Namecheap 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===
 +
* Namecheap's API is IP restricted.
 +
* Therefore to use the Namecheap API, you must first [https://www.namecheap.com/ open a ticket] with them and request they allow your server IP address access to use your Namecheap account via the API.
 +
* You can find the IP you need them to whitelist by navigating to Help > License Information within your WHMCS admin area.
 +
 
 +
<div class="docs-alert-info">Failure to do this will result in you seeing the error message, "Registrar Error Invalid Client IP"</div>
 +
 
 +
===Test Mode===
 +
WHMCS can be configured for testing purposes by ticking the "TestMode" option when configuring Namecheap as the registrar. This will point all domain related requests to the test environment provided to you by Namecheap.
 +
 
 +
==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 Namecheap 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==
 +
'''Registrar Error Invalid Client IP'''<br>
 +
Seeing this error indicates that your Server IP has not been whitelisted for API access. Please refer to [[Namecheap2#IP Registration|IP Registration]] above to resolve.
  
 
{{modules}}
 
{{modules}}

Revision as of 15:51, 30 January 2018

Supported Features

Register Transfer Renew Registrar Lock
Yes Yes Yes Yes
Update Nameservers Update WHOIS Get EPP Code Register Nameservers
Yes Yes No Yes
DNS Record Management Email Forwarding Domain Release Domain Sync Script
Yes Yes No Yes
Premium Domains Transfer Out Automation TLD Pricing Sync
No No No

Activation

To activate and begin using the Namecheap registrar module, follow the steps below:

  1. Login to your WHMCS Admin Area
  2. Navigate to Setup > Products/Services > Domain Registrars
  3. Locate Namecheap in the list
  4. Click the Activate button
  5. Enter your Namecheap API credentials
  6. Click Save Changes to complete the process
Before you can begin using the Namecheap API with your account you must authorize your server IP for access to your account. See below for steps to do this.

IP Registration

  • Namecheap's API is IP restricted.
  • Therefore to use the Namecheap API, you must first open a ticket with them and request they allow your server IP address access to use your Namecheap account via the API.
  • You can find the IP you need them to whitelist by navigating to Help > License Information within your WHMCS admin area.
Failure to do this will result in you seeing the error message, "Registrar Error Invalid Client IP"

Test Mode

WHMCS can be configured for testing purposes by ticking the "TestMode" option when configuring Namecheap as the registrar. This will point all domain related requests to the test environment provided to you by Namecheap.

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 Namecheap 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

Registrar Error Invalid Client IP
Seeing this error indicates that your Server IP has not been whitelisted for API access. Please refer to IP Registration above to resolve.

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