ResellerClub

From WHMCS Documentation

Revision as of 19:28, 9 September 2021 by SarahK (talk | contribs)

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.

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

  1. Log in 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 Activate.
  5. Enter your Resellerclub API credentials.
  6. Click Save Changes.
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.

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: 

Access Denied: You are not authorized to perform this action.

To do this:

  1. Log in to the LogicBoxes/ResellerClub control panel.
  2. Navigate to Settings > API.
  3. Enter your server's IP address.
    Use the Valid IP IP address in the WHMCS Admin Area at Help > License Information.
  4. Click Save Whitelisted IP addresses.

Configuration

User Profile Menu

To configure ResellerClub:

  1. Log in to the ResellerClub control panel.
  2. Go to User Profile > Manage Profile.
  3. Note the Reseller ID.
  4. Go to Settings -> API.
  5. Enter the IP address of your WHMCS installation's server.
  6. Note the API Key.

Use the Reseller ID and API Key to configure the Resellerclub module in WHMCS.

Designated Agent

This option changes the approval workflow for updating the Whois contact details and transferring domain names. For more information, see the ResellerClub documentation.

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. Use of your Live Account credentials, even with the Test URL, will result in actions performed in the live environment.

ResellerClub Demo Platform orders will simulate domain registration and management functions, but this will not register a domain and will not charge you. This can be useful to test WHMCS configurations.

To use the ResellerClub demo mode:

  1. Register for an account on the dedicated demo system.
  2. In WHMCS, navigate to ResellerClub at Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Domain Registrars.
  3. Enter the new Reseller ID and API Key for your demo account.
  4. Check TestMode.
  5. Click Save Changes.

After testing, enter the Reseller ID and API Key of your live account and uncheck TestMode.

Note:
Live nameservers will return a Nameserver is not a valid Nameserver error unless you create and register them 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. 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 registering them on the demo environment.

IDN Configuration

Note:
The following information relates to version 7.10 and below only.

To register internationalized domain names (IDN) through ResellerClub, an additional domain field is required. This field is added to WHMCS via the resources/domains/additionalfields.php file.

The language options differ for each TLD. You can find the appropriate values for each case 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",
);

Similarly, 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 the Additional Domain Fields documentation.

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.

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.

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.

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.

To enable automatic registration, see Configuring Automatic Registration.

Automatic Domain Synchronization

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 () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings. Also ensure that 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 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 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.

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.

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

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