Difference between revisions of "OpenSRS"

Revision as of 20:18, 29 September 2021

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:

Log in to the WHMCS Admin Area.
Go to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > Domain Registrars.
Click Activate for OpenSRS.
Enter your OpenSRS API credentials.
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

@@ Line 20: / Line 20: @@
 # Click '''Save Changes'''.
-<div class="docs-alert-warning">Before you can begin using the OpenSRS API with your account you must authorize your server IP for access to your account. See below for steps to do this.</div>
+<div class="docs-alert-warning">Before you can begin using the OpenSRS API, you must authorize your server IP address for access to your account using the steps below.</div>
-===IP Registration===
+===IP Address Registration===
-* OpenSRS's API is IP restricted.
-* Therefore to use the OpenSRS API, you must first access the OpenSRS Reseller Web Interface using your OpenSRS username and password, and then access the “Add IPs for Script/API Access” link.
+* OpenSRS's API is IP address-restricted.
-* 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.
+* 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 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 unzipped and the contents uploaded into the /modules/registrars/opensrs/ folder.
+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 [http://www.whmcs.com/members/dl.php?type=d&id=29 here]. Then, unzip them and upload them to the <tt>/modules/registrars/opensrs/</tt> folder.
-http://www.whmcs.com/members/dl.php?type=d&id=29
+You must also configure [[Domains Management|domain pricing]] in WHMCS.
-Finally, domain pricing needs to be configured within WHMCS.  Please see the  [[Domains Management]] page for additional help on doing that.
 ===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.
+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 using OpenSRS for domain registrations your OpenSRS reseller account should be configured and funded for use.
+Before you can use OpenSRS for domain registrations, you must configure and fund your OpenSRS reseller account. For more information, see [http://opensrs.com/resources OpenSRS's documentation].
-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.
 ==Automatic Registration==
-WHMCS allows you to setup 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.
+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 [[Domain Pricing|Configuring Automatic Registration]].
-To enable automatic registration, please refer to [[Domain Pricing|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 enable this functionality, you need to ensure you have the '''Domain Sync Enabled''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Domains''' or, prior to WHMCS 8.0, '''Setup > General Settings > Domains'''. Ensure you have the [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system.
+To use this:
+* Enable '''Domain Sync Enabled''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Domains''' or, prior to WHMCS 8.0, '''Setup > General Settings > Domains'''.
+* Make certain that you have [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system.
 ==Troubleshooting==
-'''Blank Response or Connection Error Message'''<br>
+===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 <tt>55443</tt> and <tt>55000</tt> so need to be opened for outbound connections.
+This usually indicates that the OpenSRS API port numbers (<tt>55443</tt> and <tt>55000</tt>) are blocked by your server's firewall and you must open them for outbound connections.
-'''Partially Loaded Page (Blank or Lost Formatting)'''<br>
+===Partially Loaded Page (Blank or Lost Formatting)===
-The OpenSRS module requires some additional files in order to work. Please refer to the [[OpenSRS#Requirements|Requirements]] section above for more info.
+The OpenSRS module requires additional files. For more information, see [[OpenSRS#Requirements|OpenSRS Requirements]].
-'''Domain Already Renewed'''<br>
+===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.
+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'''<br>
+===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.
+The system still registers the domain name when this error occurs. To stop the error, set '''Process Immediately''' to '''Off''' in your OpenSRS account.
 {{modules}}

Documentation