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 ==
+To activate and begin using the OpenSRS registrar module:
-==Activation==
+# 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]].
-To activate and begin using the OpenSRS registrar module, follow the steps 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'''.
+# 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 [http://opensrs.com/resources OpenSRS's documentation].
-# Login to your WHMCS Admin Area
+=== Test Mode ===
-# Navigate to Setup > Products/Services > Domain Registrars
-# Locate OpenSRS in the list
-# Click the '''Activate''' button
-# Enter your OpenSRS API credentials
-# Click Save Changes to complete the process
-<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>
+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.
-===IP Registration===
+=== Additional Registrar Module Files Requirement ===
-* 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.
-* 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===
+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 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.
-http://www.whmcs.com/members/dl.php?type=d&id=29
+== Automatic Registration ==
-Finally, domain pricing needs to be configured within WHMCS.  Please see the  [[Domains Management]] page for additional help on doing that.
+WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.
-===Private Key Generation===
+To enable automatic registration, see [[Domain Pricing]].
-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.
-===Configuring your OpenSRS Reseller Account===
+== Automatic Domain Synchronization ==
-Before using OpenSRS for domain registrations your OpenSRS reseller account should be configured and funded for use.
+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'''.
-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).
+== Troubleshooting ==
-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.
+=== Blank Response or Connection Error Message ===
-==Automatic Registration==
+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.
-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.
-To enable automatic registration, please refer to [[Domain Pricing|Configuring Automatic Registration]]
-==Automatic Domain Synchronization==
+=== Partially Loaded Page (Blank or Lost Formatting) ===
-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 Setup > General Settings > Domains and ensure you have the [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system.
+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]].
-==Troubleshooting==
+=== Domain Already Renewed ===
-'''Blank Response or Connection Error Message'''<br>
-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)'''<br>
+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.
-The OpenSRS module requires some additional files in order to work. Please refer to the [[OpenSRS#Requirements|Requirements]] section above for more info.
-'''Domain Already Renewed'''<br>
+=== Order xxxxxxx is not a pending, declined or cancelled order and cannot be processed ===
-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'''<br>
+The system still registers the domain name when this error occurs. To stop the error, set '''Process Immediately''' to '''Off''' in your OpenSRS account.
-The domain name will still be registered, but changing the "Process Immediately" setting in your OpenSRS account to "Off" will stop this error occurring.
 {{modules}}

Documentation