ResellerClub - Revision history

JuanR: /* Automatic Domain Synchronization */

2023-06-07T12:23:02Z

‎Automatic Domain Synchronization

SarahK: /* IDN Configuration */

2023-01-06T20:34:07Z

‎IDN Configuration

AlexN: /* About this Module */

2022-09-20T09:56:40Z

‎About this Module

SarahK at 18:39, 21 April 2022

2022-04-21T18:39:52Z

SarahK at 16:31, 14 April 2022

2022-04-14T16:31:07Z

Show changes

SarahK at 14:17, 14 March 2022

2022-03-14T14:17:18Z

SarahK: /* IP Registration */

2022-01-18T18:48:04Z

‎IP Registration

SarahK at 15:03, 29 September 2021

2021-09-29T15:03:09Z

SarahK: /* Language code not valid for this TLD */

2021-09-16T14:50:29Z

‎Language code not valid for this TLD

SarahK at 14:49, 16 September 2021

2021-09-16T14:49:50Z

@@ Line 126: / Line 126: @@
 == 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''' 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'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.
+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==

← Older revision		Revision as of 20:34, 6 January 2023
Line 98:		Line 98:

	For more information, see [[Additional Domain Fields]].		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 ===		=== Domain Contacts ===

@@ Line 19: / Line 19: @@
 | premium = yes
 | transferout = yes
 }}

@@ Line 40: / Line 40: @@
 # 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'''.
+#* 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.
@@ Line 140: / Line 140: @@
 ==== Invalid Password/Username, or your User account maybe Inactive or Suspended ====
-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.
+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.
 ==== Website Doesn't Exist For xxx ====
@@ Line 164: / Line 164: @@
 ==== 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 (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
+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'''.
 ==== Required parameter missing: name ====
@@ Line 171: / Line 171: @@
 * Enter the client's details in the '''Profile''' and '''Contacts''' tabs.
-* Enter your company details in the '''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'''.
+* 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'''.
-Also make certain to check '''Use Clients Details''' in the '''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'''.
+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'''.
 ==== There is already a pending action on this domain ====

@@ Line 15: / Line 15: @@
 | transferout = yes
 }}
 ==Activation==

@@ Line 35: / Line 35: @@
 </div>
-=== IP Registration ===
+=== IP Address Registration ===
-  Access Denied: You are not authorized to perform this action.
+ResellerClub's API is IP address-restricted. To use it, you must allow your server's IP address to access your ResellerClub account via the API.
-−
-To do this:
+Failure to do this will result in the following error in WHMCS 8.4 and later:
-−
 # Log in to the LogicBoxes/ResellerClub control panel.
 # Navigate to '''Settings > API'''.

@@ Line 78: / Line 78: @@
 To use the ResellerClub demo mode:
-# [https://demoserver.partnersite.myorderbox.com/reseller.php?action=show_signupform Register for an account on the dedicated demo system.]
+# Register for an account [https://demoserver.partnersite.myorderbox.com/reseller.php?action=show_signupform on the dedicated demo system].
 # In WHMCS, navigate to '''ResellerClub''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Domain Registrars'''.
 # Enter the new '''Reseller ID''' and '''API Key''' for your demo account.
@@ Line 100: / Line 100: @@
 </div>
-To register internationalized domain names (IDNs) through ResellerClub, an additional domain field is required. This field is added to WHMCS via the <tt>resources/domains/additionalfields.php</tt> file.
+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].
@@ Line 119: / Line 119: @@
 </source>
-Similarly, for <tt>.org</tt> domains, add the following line to the <tt>/resources/domains/additionalfields.php</tt> file:
+For <tt>.org</tt> domains, add the following line to the <tt>/resources/domains/additionalfields.php</tt> file:
 <source lang="php">
@@ Line 137: / Line 137: @@
 ===Domain Contacts===
-In WHMCS version 5.x and below, domain registration through LogicBoxes modules (ResellerClub, NetEarthOne, Stargate) always used the client's profile data, regardless of whether '''User Client Details''' was disabled.
+In WHMCS version 5.x and below, domain registration through LogicBoxes modules (ResellerClub, NetEarthOne, 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 version 6.x and above, 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.
+In WHMCS 6.x and above, 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 give you the flexibility to offer more extensions and always get the best value.
+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|Configuring Automatic Registration]].
@@ Line 153: / Line 153: @@
 The ResellerClub module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.
-To use this functionality, enable '''Domain Sync Enabled''' in the '''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'''. Also ensure that you have the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]''' configured on your system.
+To use this, enable '''Domain Sync Enabled''' in the '''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'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.
 ==Troubleshooting==
@@ Line 159: / Line 159: @@
 ==== Connection Problems ====
-The following errors occur when the ResellerClub server is unreachable. They may be experiencing problems or it could be a local firewall blocking the connection:
+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]
+* [http://www.myorderbox.com/anacreon/servlet/APIv3 HTTP Error: Couldn't open socket connection to server].
-* Domain Registration Error  - Unable to connect to Registry
+* Domain Registration Error  - Unable to connect to Registry.
 ==== Access Problems ====
@@ Line 168: / Line 168: @@
 The following errors indicate problems accessing ResellerClub:
-* Access Denied: You are not authorized to perform this action
+* Access Denied: You are not authorized to perform this action.
-* CURL Error: 7 - couldn't connect to host
+* CURL Error: 7 - couldn't connect to host.
-Usually, this indicates that you haven't yet 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.
+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. Usually, this is the IP address your WHMCS license is assigned to. If you experience problems, ResellerClub can assist and advise you of the IP address they see your connection tests.
+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 (<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.
+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.
 ==== Website Doesn't Exist For xxx ====
-This error displays when the domain does not exist in your ResellerClub account while a domain transfer is in progress. It automatically disappears when the transfer is complete.
+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 ====
@@ Line 201: / Line 201: @@
 ==== 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 (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
+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'''.
 ==== Required parameter missing: name ====
@@ Line 214: / Line 214: @@
 ==== 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 1 day. This policy came into effect on 1st December 2016, and you can read more about it [http://blog.whmcs.com/?t=121202 in our blog].
+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.
-==== Further Help ====
+For more information, see [http://blog.whmcs.com/?t=121202 in our blog].
 {{modules}}

@@ Line 189: / Line 189: @@
 ==== 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]].
+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]].
 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].

@@ Line 22: / Line 22: @@
 </div>
-To activate and begin using the ResellerClub registrar module, follow the steps below:
+To activate and begin using the ResellerClub registrar module:
-# Log in to your WHMCS Admin Area.
+# Log in to the WHMCS Admin Area.
-# Navigate 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'''.
+# 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'''.
-# Locate '''ResellerClub''' in the list.
+# Find '''ResellerClub''' in the list.
 # Click '''Activate'''.
 # Enter your Resellerclub API credentials.
 # Click '''Save Changes'''.
-<div class="docs-alert-warning">Before you can begin using the ResellerClub API with your account you must authorize your server IP for access to your account. For more information, see the sections below.</div>
+<div class="docs-alert-warning">
 === IP Registration ===
-ResellerClub's API is IP restricted. To use the ResellerClub API, you must first allow your server's IP address to access your ResellerClub account via the API. Failure to do this will result in the following error:
+ResellerClub's API is IP address-restricted. To use the ResellerClub API, you must allow your server's IP address to access your ResellerClub account via the API. Failure to do this will result in the following error:
   Access Denied: You are not authorized to perform this action.
@@ Line 98: / Line 100: @@
 </div>
-To register internationalized domain names (IDN) through ResellerClub, an additional domain field is required. This field is added to WHMCS via the <tt>resources/domains/additionalfields.php</tt> file.
+To register internationalized domain names (IDNs) through ResellerClub, an additional domain field is required. This field is added to WHMCS via the <tt>resources/domains/additionalfields.php</tt> file.
-The language options differ for each TLD. You can find the appropriate values for each case in the ''idnLanguageCode'' section in the [http://manage.uk.resellerclub.com/kb/answer/752#heading_1 ResellerClub API Documentation].
+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:
@@ Line 137: / Line 139: @@
 In WHMCS version 5.x and below, domain registration through LogicBoxes modules (ResellerClub, NetEarthOne, 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 all 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.
+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 version 6.x and above, 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.
@@ Line 189: / Line 191: @@
 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 [http://manage.uk.resellerclub.com/kb/answer/752#heading_1 ResellerClub API Documentation].
+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].
 ==== An unknown fault occurred - please contact support ====
@@ Line 209: / Line 211: @@
 Also make certain to check '''Use Clients Details''' in the '''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'''.
 ==== 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 1 day. This policy came into effect on 1st December 2016, you can read more http://blog.whmcs.com/?t=121202 about it in our blog].
+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 1 day. This policy came into effect on 1st December 2016, and you can read more about it [http://blog.whmcs.com/?t=121202 in our blog].
 ==== Further Help ====
-The answer to some common questions regarding the ResellerClub accounts provided by WHMCS are published at [[ResellerClub_Reseller_Accounts_FAQ]]
+The answer to some common questions regarding the ResellerClub accounts provided by WHMCS are published at [[ResellerClub_Reseller_Accounts_FAQ]].
-For detailed help with ResellerClub accounts and management, refer to their [http://freeaccount.myorderbox.com/kb/ knowledgebase].
+For detailed help with ResellerClub accounts and management, see their [http://freeaccount.myorderbox.com/kb/ knowledgebase].
 {{modules}}