Difference between revisions of "OpenSRS"

Latest revision as of 12:21, 7 June 2023

About this Module

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

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:

Check to ensure that your server includes all required third-party classes (for example, PEAR). If it does not, see the section below.
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.
Find OpenSRS in the list.
Click Activate.
Enter your OpenSRS credentials. You can generate your PrivateKey value at Generate New Private Key in the OpenSRS Reseller Web Interface.
Click Save Changes.
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.
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 or, prior to WHMCS 8.0, Setup > Automation Settings.

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.

Download these files and then upload them to the /modules/registrars/opensrs/ folder.
For more information, see OpenSRS Activation.

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 1: / Line 1: @@
+== About this Module ==
+The OpenSRS module allows you to register and manage domains with OpenSRS.
 {{registrar
 | register = yes
@@ Line 10: / Line 13: @@
 | domainsync = yes
 }}
+== Activation ==
-==Activation==
 To activate and begin using the OpenSRS registrar module:
+# 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|the section below]].
 # Log in to the WHMCS Admin Area.
-# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
-# Click '''Activate''' for '''OpenSRS'''.
+# Find '''OpenSRS''' in the list.
-# Enter your OpenSRS API credentials.
+# Click '''Activate'''.
+# Enter your OpenSRS credentials. You can generate your '''PrivateKey''' value at '''Generate New Private Key''' in the OpenSRS Reseller Web Interface.
 # Click '''Save Changes'''.
+# 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]]'''.
+# Configure and fund your OpenSRS reseller account. For more information, see [http://opensrs.com/resources OpenSRS's documentation].
-<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>
+=== Test Mode ===
-===IP Address Registration===
+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.
-* OpenSRS's API is IP address-restricted.
+=== Additional Registrar Module Files Requirement ===
-* 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===
+If your server does not include all of the required third-party classes, you must [https://www.whmcs.com/members/dl.php?type=d&id=29 download the necessary files] and upload them to the <tt>/modules/registrars/opensrs/</tt> directory.
-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.
-You must also configure [[Domains Management|domain pricing]] in WHMCS.
+== Automatic Registration ==
-===Private Key Generation===
+WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.
-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===
+To enable automatic registration, see [[Domain Pricing]].
-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].
-==Automatic Registration==
+== Automatic Domain Synchronization ==
-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]].
+This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.
+To use this, enable '''Domain Sync Enabled''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.
-==Automatic Domain Synchronization==
+== Troubleshooting ==
-The OpenSRS module supports automatic domain synchronization for syncing of expiry dates and status changes for incoming transfers.
-To use this:
+=== Blank Response or Connection Error Message ===
-* 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===
 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)===
+=== Partially Loaded Page (Blank or Lost Formatting) ===
-The OpenSRS module requires additional files. For more information, see [[OpenSRS#Requirements|OpenSRS Requirements]].
+The OpenSRS module requires additional files.
+[http://www.whmcs.com/members/dl.php?type=d&id=29 Download these files] and then upload them to the <tt>/modules/registrars/opensrs/</tt> folder.<br>
+For more information, see [[OpenSRS#Activation|OpenSRS Activation]].
+=== Domain Already Renewed ===
+This indicates that the '''Expiry Date''' value in the client's '''[[Clients:Domains Tab|Domains]]''' tab is invalid or incorrect. Correcting this value allows domain renewal.
-===Domain Already Renewed===
+=== Order xxxxxxx is not a pending, declined or cancelled order and cannot be processed ===
-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.
 {{modules}}

Documentation