Difference between revisions of "ResellerClub"

From WHMCS Documentation
(→‎Automatic Domain Synchronization)
 
(75 intermediate revisions by 11 users not shown)
Line 1: Line 1:
−
==AKA DirectI==
+
== About this Module ==
  
 +
The ResellerClub module allows you to register and manage domains with ResellerClub.
 +
 +
For more information, see [[ResellerClub Reseller Accounts FAQ]].
 
{{registrar
 
{{registrar
 
| register = yes
 
| register = yes
Line 10: Line 13:
 
| getepp = yes
 
| getepp = yes
 
| regns = yes
 
| regns = yes
 +
| dnsmanagement = yes
 +
| emailforwarding = yes
 +
| domainrelease = yes
 +
| domainsync = yes
 +
| premium = yes
 +
| transferout = yes
 +
| tldpricingsync = yes
 
}}
 
}}
  
−
If you don't already have an account with ResellerClub/DirectI, you can signup for the free account we offer to all clients [http://www.whmcs.com/resellerclubdomains.php here]!
+
== Activation ==
 +
 
 +
<div class="docs-alert-success">
 +
You must sign up for a [https://freeaccount.partnersite.myorderbox.com/reseller.php?action=show_signupform ResellerClub account].
 +
</div>
 +
 
 +
To activate and begin using the ResellerClub registrar module:
 +
 
 +
# 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 '''ResellerClub''' in the list.
 +
# Click '''Activate'''.
 +
# Enter your Resellerclub API credentials and configure the module's settings. [[File:Rcprofile.png|thumb|User Profile Menu]]
 +
#* You can find your ResellerClub API credentials in the ResellerClub control panel:
 +
#** Your reseller ID appears at '''User Profile > Manage Profile'''.
 +
#** Your API key appears at '''Settings > API'''.
 +
#* Enable '''Designated Agent''' to act as the designated agent for all contact changes. For more information, [https://freeaccount.myorderbox.com/kb/node/5 see the ResellerClub documentation].
 +
# Click '''Save Changes'''.
 +
# Grant API access to your ResellerClub account to your server's IP address. You can do this by going to '''Settings > API''' in the LogicBoxes/ResellerClub control panel and entering your IP address.
 +
#* You can find the IP address to use in WHMCS at '''Help > [[License Information]]'''.
 +
#* If you do not do this, you will see a <tt>You must authorize your IP address to use this API.</tt> error in WHMCS 8.4 and later or an <tt>Access Denied</tt> error in WHMCS 8.3 and earlier.
 +
 
 +
=== Test Mode ===
 +
 
 +
<div class="docs-alert-warning">
 +
ResellerClub requires the use of a '''Demo Account Reseller ID''' and '''API Key''' with the '''Test URL''' instead of your '''Live Account''' credentials. Use of your '''Live Account''' credentials, even with the '''Test URL''', will cause you to [http://freeaccount.myorderbox.com/kb/answer/753#heading_6 perform actions in the live environment].
 +
</div>
 +
 
 +
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.
 +
 
 +
==== Nameservers ====
 +
 
 +
Live nameservers will return a <tt>Nameserver is not a valid Nameserver</tt> error unless you create and register them in the demo environment before attempting domain registrations on the demo platform. The demo control panel will try to check the validity of the nameservers in the demo platform and not on the registry.
 +
 
 +
You can use <tt><nowiki>ns1.onlyfordemo.net</nowiki></tt> and <tt><nowiki>ns2.onlyfordemo.net</nowiki></tt> as your nameservers without registering them on the demo environment.
 +
 
 +
=== IDN Configuration ===
 +
 
 +
<div class="docs-alert-info">
 +
The following information is for WHMCS 7.10 and earlier.
 +
</div>
 +
 
 +
To register internationalized domain names (IDNs) through ResellerClub, you must add an additional domain field to WHMCS via the <tt>resources/domains/additionalfields.php</tt> file.
 +
 
 +
The language options differ for each TLD. You can find the appropriate values in the <tt>idnLanguageCode</tt> section in the [http://manage.uk.resellerclub.com/kb/answer/752#heading_1 ResellerClub API Documentation].
 +
 
 +
For example, to register a <tt>.eu</tt> domain, add the following line to the <tt>/resources/domains/additionalfields.php</tt> file:
 +
 
 +
<source lang="php">
 +
<?php
 +
$additionaldomainfields[".eu"][] = array(
 +
    "Name" => "IDN Language",
 +
    "DisplayName" => "IDN Language",
 +
    "LangVar" => "idnlang",
 +
    "Type" => "dropdown",
 +
    "Options" => "latin",
 +
    "Default" => "latin",
 +
    "Required" => "true",
 +
);
 +
</source>
 +
 
 +
For <tt>.org</tt> domains, add the following line to the <tt>/resources/domains/additionalfields.php</tt> file:
 +
 
 +
<source lang="php">
 +
$additionaldomainfields[".org"][] = array(
 +
    "Name" => "IDN Language",
 +
    "DisplayName" => "IDN Language",
 +
    "LangVar" => "idnlang",
 +
    "Type" => "dropdown",
 +
    "Options" => "da,de,hu,is,ko,lv,lt,pl,es,sv",
 +
    "Default" => "da",
 +
    "Required" => "true",
 +
);
 +
</source>
 +
 
 +
For more information, see [[Additional Domain Fields]].
 +
 
 +
=== Terms and Conditions ===
 +
 
 +
ResellerClub requires that clients agree to their terms and conditions when registering a domain. To do this, it adds an additional checkbox to the registration process.
 +
 +
To translate the checkbox name, use <tt>tnc</tt> as the <tt>LangVar</tt> key in the appropriate language file in the <tt>lang/overrides/</tt> directory:
 +
 
 +
<source lang="php">
 +
$_LANG['tnc'] = 'I agree to the ResellerClub terms and conditions.';
 +
</source>
 +
 +
For more information, see [[Additional_Domain_Fields#Translate_a_field_name|Additional Domain Fields]].
 +
 
 +
=== Domain Contacts ===
 +
 
 +
Prior to WHMCS 6, domain registration through LogicBoxes modules (ResellerClub, NetEarthOne, and Stargate) always used the client's profile data regardless of whether '''User Client Details''' was disabled.
 +
 
 +
If a client has multiple registered domains, they will use the same contact details for all four Whois contacts. Changing the Whois details on one domain will also change the details for the others.
 +
 
 +
In WHMCS 6 and later, domain registration creates a unique contact for each domain. This contact becomes the Registrant, Billing, Tech, and Admin contact for the domain's Whois records. Modifying the Whois details for the domain will change only that domain.
 +
 
 +
== 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 [[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==
 +
 
 +
==== Connection Problems ====
 +
 
 +
The following errors occur when the ResellerClub server is unreachable. They may be experiencing problems or a local firewall may block the connection:
 +
 
 +
* [http://www.myorderbox.com/anacreon/servlet/APIv3 HTTP Error: Couldn't open socket connection to server].
 +
* Domain Registration Error  - Unable to connect to Registry.
 +
 
 +
==== Access Problems ====
 +
 
 +
The following errors indicate problems accessing ResellerClub:
 +
 
 +
* Access Denied: You are not authorized to perform this action.
 +
* CURL Error: 7 - couldn't connect to host.
 +
 
 +
Usually, this indicates that you haven't allowed your server's IP address to access your ResellerClub account via the API. Do this in the '''Settings > API''' section of the LogicBoxes control panel.
 +
 
 +
The IP address you need to authorize is typically the main shared IP address of the server, which is usually the IP address your WHMCS license is assigned to. If you experience problems, contact ResellerClub.
  
−
==DirectI vs ResellerClub==
+
==== Invalid Password/Username, or your User account maybe Inactive or Suspended ====
  
−
WHMCS has two domain registrar modules; DirectI and ResellerClub. You can use either with a ResellerClub/DirectI account, the different modules determine the way domains are registered and how your customers manage them.
+
This error response indicates that the login details in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Domain Registrars''', for the Resellerclub module are incorrect or your account is suspended.
  
−
The DirectI module requires that you create a customer under your reseller account, all domain orders will be placed by this customer. Your customers can only manage their domain names through WHMCS.
+
==== Website Doesn't Exist For xxx ====
  
−
The ResellerClub module will create a customer account under your reseller account for each of your customers. They will be able to login to the SuperSite interface and manage their domain names (this offers more options than WHMCS alone). Your customers can still use WHMCS to manage their domain names.
+
This error indicates that the domain does not exist in your ResellerClub account while a domain transfer is in progress. It automatically disappears when the transfer is complete.
  
−
If you want your customers to be given a login to the SuperSite interface then you should choose the ResellerClub module, if you do not, choose DirectI.
+
==== Telephone No. is invalid. Please note that only digits are allowed ====
  
−
==Configuration in WHMCS==
+
This error displays when you include a country code in a phone number. Only enter the phone number as it would be called from that country.
  
−
#Login to your domain reseller account as instructed in the email you received when you signed up and go to Settings > Personal Information > Primary Profile - the value you need to note is the Parent ID
+
==== Language code not valid for this TLD ====
−
#Next, login to your WHMCS Administration Area
 
−
#Go to Configuration > Domain Registrars
 
−
#Choose "Resellerclub" in the registrar dropdown menu and enter the email address and password you set when you signed up aswell as the Parent ID noted from the first step
 
−
#Then click Save Changes
 
  
−
And that's it, WHMCS will now be able to communication with your DirectI/ResellerClub account to automate domain registration & management for your customers.
+
This error occurs when attempting to register an IDN without specifying a valid language for the domain. For more information, see [[#IDN_Configuration|IDN Configuration]].
  
−
==Demo Mode==
+
If you have already configured a IDN Language additional domain field, this error indicates that the selected language is not valid for the TLD. For more information, see the  <tt>idnLanguageCode</tt> section in the [http://manage.uk.resellerclub.com/kb/answer/752#heading_1 ResellerClub API Documentation].
  
−
To use the ResellerClub demo mode, it's not as simple as ticking the demo mode option in the configuration area.  You must setup an account seperately on the dedicated demo system they offer @ http://cp.onlyfordemo.net/reseller
+
==== An unknown fault occurred - please contact support ====
  
−
==Expiry Date Syncronisation==
+
This error occurs when the client's profile data contains characters other than a-z and 0-9. The ResellerClub API won't accept any accents or other non-Latin characters.
  
−
As of V3.6, you can now have WHMCS sync the expiry dates of domains you have registered with DirectI.  This is particularly useful for domain transfers where the expiry date cannot be calculated automatically. We recommend running the sync once per week.  To do that, you need to setup a cron job to run the file modules/registrars/resellerclub/resellerclubsync.php using a command such as the one below.
+
You can customize WHMCS to automatically convert non-Latin characters. For more information, see [[Custom Transliteration]].
  
−
php -q /home/username/public_html/modules/registrars/resellerclub/resellerclubsync.php
+
==== An unexpected error has occurred ====
  
−
==Common Problems==
+
This error usually indicates that the login details are missing or incorrect. Make sure that you have correctly entered your reseller ID and API key at '''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'''.
  
−
===Connection Problems===
+
==== Required parameter missing: name ====
  
−
*HTTP Error: Couldn't open socket connection to server: http://www.myorderbox.com/anacreon/servlet/APIv3
+
This error indicates that ResellerClub is not receiving the client's details. Make sure to enter the appropriate information in the following locations:
−
*Domain Registration Error  - Unable to connect to Registry
 
  
−
These errors occur when the ResellerClub server is unreachable. They may be experiencing problems or it could be a local firewall blocking the connection.
+
* Enter the client's details in the '''Profile''' and '''Contacts''' tabs.
 +
* Enter your company details in the '''[[Domains Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
  
−
===Invalid Password/Username, or your User account maybe Inactive or Suspended ===
+
Also make certain to check '''Use Clients Details''' in the '''[[Domains Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
−
This error response means the login details you have entered in Configuration > Domain Registrars for the Resellerclub module are incorrect or your account is suspended. A suspended account is unlikely so make sure to check your configuration details first.
 
  
−
===Telephone No. is invalid. Please note that only digits are allowed===
+
==== There is already a pending action on this domain ====
−
You should only enter the phone number as it would be called from that country. No country codes should be entered.
 
  
−
===Furthur Help===
+
This message indicates that a Whois contact details update is pending on this domain.  Once the new contact details are confirmed by the new and old contact, this message will disappear within one day.  
−
For furthur help with ResellerClub accounts and management, refer to their knowledgebase @ http://freeaccount.myorderbox.com/kb/
 
  
 +
For more information, see [http://blog.whmcs.com/?t=121202 in our blog].
  
 
{{modules}}
 
{{modules}}

Latest revision as of 12:23, 7 June 2023

About this Module

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

For more information, see ResellerClub Reseller Accounts FAQ.

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

Activation

You must sign up for a ResellerClub account.

To activate and begin using the ResellerClub registrar module:

  1. Log in to the WHMCS Admin Area.
  2. Go to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
  3. Find ResellerClub in the list.
  4. Click Activate.
  5. Enter your Resellerclub API credentials and configure the module's settings.
    User Profile Menu
    • You can find your ResellerClub API credentials in the ResellerClub control panel:
      • Your reseller ID appears at User Profile > Manage Profile.
      • Your API key appears at Settings > API.
    • Enable Designated Agent to act as the designated agent for all contact changes. For more information, see the ResellerClub documentation.
  6. Click Save Changes.
  7. Grant API access to your ResellerClub account to your server's IP address. You can do this by going to Settings > API in the LogicBoxes/ResellerClub control panel and entering your IP address.
    • You can find the IP address to use in WHMCS at Help > License Information.
    • If you do not do this, you will see a You must authorize your IP address to use this API. error in WHMCS 8.4 and later or an Access Denied error in WHMCS 8.3 and earlier.

Test Mode

ResellerClub requires the use of a Demo Account Reseller ID and API Key with the Test URL instead of your Live Account credentials. Use of your Live Account credentials, even with the Test URL, will cause you to perform actions in the live environment.

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.

Nameservers

Live nameservers will return a Nameserver is not a valid Nameserver error unless you create and register them in the demo environment before attempting domain registrations on the demo platform. The demo control panel will try to check the validity of the nameservers in the demo platform and not on the registry.

You can use ns1.onlyfordemo.net and ns2.onlyfordemo.net as your nameservers without registering them on the demo environment.

IDN Configuration

The following information is for WHMCS 7.10 and earlier.

To register internationalized domain names (IDNs) through ResellerClub, you must add an additional domain field to WHMCS via the resources/domains/additionalfields.php file.

The language options differ for each TLD. You can find the appropriate values in the idnLanguageCode section in the ResellerClub API Documentation.

For example, to register a .eu domain, add the following line to the /resources/domains/additionalfields.php file: 

<?php
$additionaldomainfields[".eu"][] = array(
    "Name" => "IDN Language",
    "DisplayName" => "IDN Language",
    "LangVar" => "idnlang",
    "Type" => "dropdown",
    "Options" => "latin",
    "Default" => "latin",
    "Required" => "true",
);

For .org domains, add the following line to the /resources/domains/additionalfields.php file: 

$additionaldomainfields[".org"][] = array(
    "Name" => "IDN Language",
    "DisplayName" => "IDN Language",
    "LangVar" => "idnlang",
    "Type" => "dropdown",
    "Options" => "da,de,hu,is,ko,lv,lt,pl,es,sv",
    "Default" => "da",
    "Required" => "true",
);

For more information, see Additional Domain Fields.

Terms and Conditions

ResellerClub requires that clients agree to their terms and conditions when registering a domain. To do this, it adds an additional checkbox to the registration process.

To translate the checkbox name, use tnc as the LangVar key in the appropriate language file in the lang/overrides/ directory: 

$_LANG['tnc'] = 'I agree to the ResellerClub terms and conditions.';

For more information, see Additional Domain Fields.

Domain Contacts

Prior to WHMCS 6, domain registration through LogicBoxes modules (ResellerClub, NetEarthOne, and Stargate) always used the client's profile data regardless of whether User Client Details was disabled.

If a client has multiple registered domains, they will use the same contact details for all four Whois contacts. Changing the Whois details on one domain will also change the details for the others.

In WHMCS 6 and later, domain registration creates a unique contact for each domain. This contact becomes the Registrant, Billing, Tech, and Admin contact for the domain's Whois records. Modifying the Whois details for the domain will change only that domain.

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

Connection Problems

The following errors occur when the ResellerClub server is unreachable. They may be experiencing problems or a local firewall may block the connection:

Access Problems

The following errors indicate problems accessing ResellerClub:

  • Access Denied: You are not authorized to perform this action.
  • CURL Error: 7 - couldn't connect to host.

Usually, this indicates that you haven't allowed your server's IP address to access your ResellerClub account via the API. Do this in the Settings > API section of the LogicBoxes control panel.

The IP address you need to authorize is typically the main shared IP address of the server, which is usually the IP address your WHMCS license is assigned to. If you experience problems, contact ResellerClub.

Invalid Password/Username, or your User account maybe Inactive or Suspended

This error response indicates that the login details in Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Domain Registrars, for the Resellerclub module are incorrect or your account is suspended.

Website Doesn't Exist For xxx

This error indicates that the domain does not exist in your ResellerClub account while a domain transfer is in progress. It automatically disappears when the transfer is complete.

Telephone No. is invalid. Please note that only digits are allowed

This error displays when you include a country code in a phone number. Only enter the phone number as it would be called from that country.

Language code not valid for this TLD

This error occurs when attempting to register an IDN without specifying a valid language for the domain. For more information, see IDN Configuration.

If you have already configured a IDN Language additional domain field, this error indicates that the selected language is not valid for the TLD. For more information, see the idnLanguageCode section in the ResellerClub API Documentation.

An unknown fault occurred - please contact support

This error occurs when the client's profile data contains characters other than a-z and 0-9. The ResellerClub API won't accept any accents or other non-Latin characters.

You can customize WHMCS to automatically convert non-Latin characters. For more information, see Custom Transliteration.

An unexpected error has occurred

This error usually indicates that the login details are missing or incorrect. Make sure that you have correctly entered your reseller ID and API key at Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.

Required parameter missing: name

This error indicates that ResellerClub is not receiving the client's details. Make sure to enter the appropriate information in the following locations:

  • Enter the client's details in the Profile and Contacts tabs.
  • Enter your company details in the Domains tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.

Also make certain to check Use Clients Details in the Domains tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.

There is already a pending action on this domain

This message indicates that a Whois contact details update is pending on this domain. Once the new contact details are confirmed by the new and old contact, this message will disappear within one day.

For more information, see in our blog.

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=ResellerClub&oldid=34101"