ResellerClub

From WHMCS Documentation

Revision as of 08:56, 6 April 2021 by PeterM (talk | contribs) (Added version note for IDN configuration)

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 No

Activation

Don't have a ResellerClub account yet?
Get one here: https://freeaccount.partnersite.myorderbox.com/reseller.php?action=show_signupform

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

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

IP Registration

ResellerClub's API is IP restricted. Therefore to use the ResellerClub API, you must first allow your servers IP to access your ResellerClub account via the API:

  1. Login to the LogicBoxes/ResellerClub control panel
  2. Navigate to Settings > API
  3. Enter your server's IP address into one of the fields
  4. Click Save Whitelisted IP addresses
  • The IP address to be whitelisted can usually be identified within the WHMCS Admin Area by navigating to Help > License Information and observing the Valid IP value
Failure to do this will result in you seeing the error message, "Access Denied: You are not authorized to perform this action"

Configuration

User Profile Menu
  1. Login to the ResellerClub control panel (the url will be in the email you received when you signed up with them) and then go to User Profile > Manage Profile - the value you need to note is the Reseller ID.
  2. Still in the ResellerClub control panel, go to Settings -> API and enter the IP address of the server where WHMCS is installed to authorize it for API access
  3. On the same page, note down the API Key.


The Reseller ID and API Key values are used when configuring the Resellerclub module within WHMCS. For more information on where to input these values, please see the Activation section above.

Designated Agent

This option changes the approval workflow used when updating the whois contact details and transferring domain names. For more information refer to the ResellerClub documentation article: https://freeaccount.myorderbox.com/kb/node/5

Demo Mode

Note:
ResellerClub requires the use of a Demo Account Reseller ID and API Key with the Test URL instead of your Live Account credentials. Usage of your Live Account credentials, even with the Test URL, will result in actions being performed in the live environment. [1]

Orders placed through the ResellerClub Demo Platform will simulate a domain registration and management functions, but no domain will actually be registered and you will not be charged. This can be useful to test WHMCS configurations prior to going live.

To use the ResellerClub demo mode:

  1. Register for an account on the dedicated demo system at: https://demoserver.partnersite.myorderbox.com/reseller.php?action=show_signupform
  2. In WHMCS, navigate to Configuration () > System Settings > Domain Registrars > ResellerClub or, prior to WHMCS 8.0, Setup > Domain Registrars > ResellerClub.
  3. Enter the new Reseller ID and API Key for your demo account
  4. Tick the TestMode checkbox
  5. Click Save Changes

Once testing is completed, enter the Reseller ID and API Key of your live account as above, and untick the TestMode checkbox.

Note:
Live nameservers created at the Registry will return a Nameserver is not a valid Nameserver error unless they are created/registered in the demo environment.

The demo control panel will try to check the validity of the nameservers in the demo platform and not on the Registry, so you must register the nameservers first before attempting any domain registrations on the demo platform.

You can use ns1.onlyfordemo.net and ns2.onlyfordemo.net as your nameservers without having to first register them on the demo environment.

IDN Configuration

Please Note:
The following information relates to version 7.10 and below. This is not required for version 8.0 and above.

In order to register internationalised domain names (IDN) through ResellerClub an additional domain field is required to specify the language of the domain being registered. This field is added to WHMCS via the resources/domains/additionalfields.php file.

The language options differ for each TLD and the appropriate values for each case are listed in the idnLanguageCode section in the ResellerClub API Documentation.

For example to register a .eu domain the following line should be added 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",
);

Similarly, for .org domains, the following line should be added 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 further information please refer to the Additional Domain Fields documentation.

Domain Contacts

In version 5.x and below, the client's profile data will always be used when registering domains through LogicBoxes modules (ResellerClub, NetEarthOne, Stargate), even if the "User Client Details option is disabled in the General Settings.

If a client has multiple domains registered 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.

In version 6.x and above, a unique contact will be created for each domain. This contact will be applied to the Registrant, Billing, Tech and Admin contact for the domain's whois records. Modifying the whois details for the domain will change only this one domain.

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

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.


Access Denied: You are not authorized to perform this action
CURL Error: 7 - couldn't connect to host
This error message indicates that you haven't yet allowed your servers IP to access your ResellerClub account via the API. You have to do this in the Settings > API section of the LogicBoxes control panel before you can use the integration.

The IP you need to authorize is typically the main shared IP of the server, usually most easily found from the IP your WHMCS license is assigned to, but if you're unsure or neither of those IPs work, then ResellerClub can assist and advise you of the IP they see your connection tests as coming from via a support ticket.

Invalid Password/Username, or your User account maybe Inactive or Suspended
This error response indicates that the login details you have entered 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. A suspended account is less likely so make sure to check your configuration details first....

Website Doesn't Exist For xxx
This error occurs when the domain does not exist in your ResellerClub account. This message will be displayed when a domain transfer is in progress but will automatically disappear when the transfer is complete.

Telephone No. is invalid. Please note that only digits are allowed
You should only enter the phone number as it would be called from that country. No country codes should be entered.

Language code not valid for this TLD
This error occurs when attempting to register an IDN without specifying a valid language for the domain. This is configured by way of an additional domain field. For instructions please refer to #IDN Configuration.

If you do have a IDN Language additional domain field configured already, this error suggests that the language value that is selected is not valid for this particular TLD. Please refer to the idnLanguageCode section in the ResellerClub API Documentation which lists the available values for each TLD.

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. Any accents or other non-latin characters need to be replaced as the ResellerClub API won't accept them. WHMCS can be customised to automatically convert non-latin characters into their Latin equivalent, please refer to Custom Transliteration.

An unexpected error has occurred
This usually indicates that the login details are missing or incorrect, please ensure you have correctly entered your Reseller ID and API Key under Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars as described above.

Required parameter missing: name
This error indicates that the client's details are not being sent to ResellerClub. Ensure the client's details are filled in the following locations:

  • Under their Profile Tab
  • Under the Contacts Tab (if a contact is specified on the order details page)
  • Your company details are specified under Configuration () > System Settings > General Settings > Domains or, prior to WHMCS 8.0, Setup > General Settings > Domains.
  • Use Clients Details is checked in Configuration () > System Settings > General Settings > Domains or, prior to WHMCS 8.0, Setup > General Settings > Domains.


Feature Deprecated. Please refer to KB link
This error is caused by a change in the ResellerClub API which changes the way domain contact details are updated effective from 1st December 2016. An update has been made in the latest release of WHMCS version 7 to prevent this situation, upgrading will prevent this message.

A patch file has also been made available for WHMCS version 6. It can be downloaded using this link: LogicBoxes IRTP API patch.

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].

Further Help
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 knowledgebase @ http://freeaccount.myorderbox.com/kb/

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=30099"