OpenSRS

From WHMCS Documentation

Revision as of 20:18, 29 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
No No No Yes
Premium Domains Transfer Out Automation TLD Pricing Sync
No No No

Activation

To activate and begin using the OpenSRS registrar module:

  1. Log in to the WHMCS Admin Area.
  2. Go to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
  3. Click Activate for OpenSRS.
  4. Enter your OpenSRS API credentials.
  5. Click Save Changes.
Before you can begin using the OpenSRS API, you must authorize your server IP address for access to your account using the steps below.

IP Address Registration

  • OpenSRS's API is IP address-restricted.
  • To use the OpenSRS API, access the OpenSRS Reseller Web Interface using your OpenSRS username and password. Then, access the Add IPs for Script/API Access link.
  • Set up the IP address that you want to publicly associate with your WHMCS instance.

Additional Registrar Module Files Requirement

OpenSRS requires some third-party classes (for example, PEAR) or the module will fail to operate entirely without these files. You can get these files here. Then, unzip them and upload them to the /modules/registrars/opensrs/ folder.

You must also configure domain pricing in WHMCS.

Private Key Generation

To generate your private key, log in to the OpenSRS Reseller Web Interface using your OpenSRS username and password. Then, click Generate New Private Key.

Configuring your OpenSRS Reseller Account

Before you can use OpenSRS for domain registrations, you must configure and fund your OpenSRS reseller account. For more information, see OpenSRS's documentation.

Automatic Registration

WHMCS allows you to set up automatic domain registration on a per-extension basis, allowing you to use different registrars for different TLDs. To enable automatic registration, see Configuring Automatic Registration.

Automatic Domain Synchronization

The OpenSRS module supports automatic domain synchronization for syncing of expiry dates and status changes for incoming transfers.

To use this:

  • Enable Domain Sync Enabled in Configuration () > System Settings > General Settings > Domains or, prior to WHMCS 8.0, Setup > General Settings > Domains.
  • Make certain that you have Domain Sync Cron configured on your system.

Troubleshooting

Blank Response or Connection Error Message

This usually indicates that the OpenSRS API port numbers (55443 and 55000) are blocked by your server's firewall and you must open them for outbound connections.

Partially Loaded Page (Blank or Lost Formatting)

The OpenSRS module requires additional files. For more information, see OpenSRS Requirements.

Domain Already Renewed

This indicates that the Expiry Date value in the client'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.

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