Revision as of 17:50, 25 January 2012

Supported Features

Configuration

To setup the OpenSRS Registrar integration in WHMCS, begin by going to Setup > Domain Registrars. Next, choose OpenSRS from the dropdown menu of available registrars and click Go to view the settings for it. You will then be asked to enter your Username and Private Key for your OpenSRS reseller account, then click save to complete.

Please Note: You also need to register your server IP within your OpenSRS reseller account to authorize access to your account. Please see below for more info on this.

Private Key Generation

To generate your private key, login to the OpenSRS Reseller Web Interface using your OpenSRS username and password and access the “Generate New Private Key” link.

IP Registration

To add your server IP, access the OpenSRS Reseller Web Interface using your OpenSRS username and password, and then access the “Add IPs for Script/API Access” link. The IP address that needs to be set up is the one that your WHMCS instance will be seen as from the world wide web.

Additional Registrar Module Files Requirement

OpenSRS requires some third party classes such as PEAR in order to work and it’s likely that the module will fail to operate entirely without these files. The files can be obtained using the following link and need to be uploaded into the /modules/registrars/opensrs/ folder.

http://www.whmcs.com/members/dl.php?type=d&id=29

Finally, domain pricing needs to be configured within WHMCS. Please see the Domains Management page for additional help on doing that.

Test Mode

WHMCS can be configured for testing purposes by ticking the “Test Mode” when configuring OpenSRS as the registrar. This will point all domain related requests to the test environment provided to you by OpenSRS.

Configuring you OpenSRS Reseller Account

Before using OpenSRS for domain registrations your OpenSRS reseller account should be configured and funded for use.

Please refer to “Setting your account defaults” and “Payments” (funding your account) sections in the “Reseller's Guide to Domain Name Registration and Management” available in the documentation section of our OpenSRS.com website (http://opensrs.com/resources).

The “Reseller's Guide to Domain Name Registration and Management” is a very important resource for managing and troubleshooting domain registrations, as is the Reseller Web Interface we provide you with your OpenSRS reseller account.

Importing Existing Domains

OpenSRS is unique in that each domain has its' own username and password, and just being the reseller that owns the domain is not enough to be able to manage it. Therefore in order to be able to manage domains registered with OpenSRS/ResellOne outside of WHMCS you will need to manually add the domains individual username & password directly to the mod_opensrs table of the database. This is in addition to adding the domain to WHMCS itself if it's not already in the database. Please refer to adding the domains to WHMCS for the steps for doing that.

Troubleshooting Tips

Blank Response or Connection Error Message

This is commonly caused by the port numbers that the OpenSRS API operates on being blocked by your server's firewall. The ports used in communication to the API are 55443 and 55000 so need to be opened for both inbound and outbound connections.

Partially Loaded Page (Blank or Lost Formatting)

The OpenSRS module requires some additional files in order to work. Please refer to the Additional Registrar Module Files Requirement section above for more info.

Domain Already Renewed

Seeing this error when attempting to renew a domain is caused by an invalid or incorrect Expiry Date value under the client's Domains tab. Correcting this value will enable the domain to be renewed.

Order xxxxxxx is not a pending, declined or cancelled order and cannot be processed

The domain name will still be registered, but changing the "Process Immediately" setting in your OpenSRS account to "Off" will stop this error occurring.