Revision as of 18:25, 2 January 2017

Supported Features

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.
4. Now, login to your WHMCS Administration Area
5. Go to Setup > Products/Services > Domain Registrars
6. Choose "Resellerclub" in the registrar dropdown menu and enter both the Reseller ID and API Key noted above.
7. Then click Save Changes

And that's it, WHMCS will now be able to communicate with your ResellerClub account to automate domain registration & management for your customers.

Demo Mode

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 separately on the dedicated demo system they offer @ http://cp.onlyfordemo.net/servlet/ResellerSignupServlet?&validatenow=false

Next enter your demo account details under Setup > Domain Registrars > ResellerClub. With the Test Mode checkbox ticked you can now place domain registration orders in WHMCS, the domains will appear on your demo ResellerClub account but no domain will actually be registered and you will not be charged.

Expiry Date Synchronisation

WHMCS can sync the expiry dates of domains you have registered with ResellerClub. This is particularly useful for domain transfers where the expiry date cannot be calculated automatically. This can be enabled under Setup > General Settings > Domains Tab.

IDN Configuration

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.

Notes

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.

Common Problems

Connection Problems

• HTTP Error: Couldn't open socket connection to server: http://www.myorderbox.com/anacreon/servlet/APIv3
• 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.

Access Denied: You are not authorized to perform this action

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.

CURL Error: 7 - couldn't connect to host

See above

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

This error response indicates that the login details you have entered in 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 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 Setup > General Settings > Domains tab > Default Billing/Admin/Tech Contact Details OR
• The Setup > General Settings > Domains tab > Use Clients Details option is ticked.

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/