OpenSRS

The OpenSRS module allows you to register and manage domains with OpenSRS.

Supported Features

RegisterTransferRenewRegistrar LockUpdate Nameservers
Update WHOISGet EPP CodeRegister NameserversDNS Record ManagementEmail Forwarding
✖️✖️
Domain ReleaseDomain Sync ScriptPremium DomainsTransfer Out AutomationTLD Pricing Sync
✖️✖️✖️✖️

Activation

To activate and begin using the OpenSRS registrar module:

  1. Check to ensure that your server includes all required third-party classes (for example, PEAR). If it does not, see Additional Registrar Module Files Requirement below.
  2. Log in to the WHMCS Admin Area.
  3. Go to Configuration () > System Settings > Domain Registrars.
  4. Find OpenSRS in the list.
  5. Click Activate.
  6. Enter your OpenSRS credentials. You can generate your PrivateKey value at Generate New Private Key in the OpenSRS Reseller Web Interface.
  7. Click Save Changes.
  8. In the OpenSRS Reseller Web Interface, go to Add IPs for Script/API Access and configure access for your server’s IP address. You can find this address in WHMCS at Help () > License Information.
  9. Configure and fund your OpenSRS reseller account. For more information, see OpenSRS’s documentation.

Test Mode

You can use test mode to simulate domain registration and management function without registering a domain or incurring charges. This can be useful to test WHMCS configurations.

Additional Registrar Module Files Requirement

If your server does not include all of the required third-party classes, you must download the necessary files and upload them to the /modules/registrars/opensrs/ directory.

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 enable automatic registration, see Domain Pricing.

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 and configure the domain sync task at Configuration () > System Settings > Automation Settings.

Troubleshooting

Blank Response or Connection Error Message

This error usually indicates that your server’s firewall has blocked the OpenSRS API ports (55443 and 55000). You must open them for outbound connections.

Partially Loaded Page (Blank or Lost Formatting)

The OpenSRS module requires additional files. Download these files and then upload them to the /modules/registrars/opensrs/ folder.

Domain Already Renewed

This indicates that the Expiry Date value in the client’s profile’s Domains tab is invalid or incorrect. Correcting this value allows domain renewal.

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

The system still registers the domain name when this error occurs. To stop the error, set Process Immediately to Off in your OpenSRS account.

Last modified: June 5, 2024