Revision as of 15:56, 25 February 2011 (view source) Matt (talk | contribs) (→‎Importing Domains) ← Older edit		Latest revision as of 12:21, 7 June 2023 (view source) JuanR (talk | contribs) (→‎Automatic Domain Synchronization)
(29 intermediate revisions by 7 users not shown)
Line 1:		Line 1:
		+	== About this Module ==
		+
		+	The OpenSRS module allows you to register and manage domains with OpenSRS.
	{{registrar		{{registrar
	| register = yes		| register = yes
Line 6:		Line 9:
	| dns = yes		| dns = yes
	| whois = yes		| whois = yes
		+	| regns = yes
	| getepp = yes		| getepp = yes
		+	| domainsync = yes
	}}		}}
		+	== Activation ==
−	==Configuration==	+	To activate and begin using the OpenSRS registrar module:
−
−	To setup the OpenSRS Registrar integration in WHMCS, begin by going to '''Setup > Domain Registrars'''. Next, choose '''OpenSRS''' from the dropdown menu of available registrars and click '''Go''' to view the settings for it. You will then be asked to enter your '''Username''' and '''Private Key''' for your OpenSRS reseller account, then click save to complete.
−
−	Please Note: You also need to register your server IP within your OpenSRS reseller account to authorize access to your account. Please see below for more info on this.
−
−	===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.
−
−	===IP Registration===
−
−	To add your server IP, 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===
−
−	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 uploaded into the /modules/registrars/opensrs/ folder.
−	http://www.whmcs.com/members/dl.php?type=d&id=29	+	# 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'''.
		+	# 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].
−	Finally, domain pricing needs to be configured within WHMCS.  Please see the  [[Domains Management]] page for additional help on doing that.	+	=== Test Mode ===
−	===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.
−	WHMCS can be configured for testing purposes by ticking the “Test Mode” when configuring OpenSRS as the registrar.  This will point all domain related requests to the test environment provided to you by OpenSRS.	+	=== 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.
−	==Configuring you OpenSRS Reseller Account==	+	== Automatic Registration ==
−	Before using OpenSRS for domain registrations your OpenSRS reseller account should be configured and funded for use.	+	WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.
−	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).	+	To enable automatic registration, see [[Domain Pricing]].
−	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 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 [[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'''.
−	==Importing Existing Domains==	+	== Troubleshooting ==
−	OpenSRS is unique in that each domain has its' own username and password, and just being the reseller that owns the domain is not enough to be able to manage it. Therefore in order to be able to manage domains registered with OpenSRS/ResellOne outside of WHMCS you will need to manually add the domains individual username & password directly to the mod_opensrs table of the database.  This is in addition to adding the domain to WHMCS itself if it's not already in the database.  Please refer to [http://wiki.whmcs.com/Importing_Data#Manual_Domain_Only_Entry adding the domains to WHMCS] for the steps for doing that.	+	=== Blank Response or Connection Error Message ===
−	==Troubleshooting Tips==	+	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.
−	===Blank Response or Connection Error Message===	+	=== Partially Loaded Page (Blank or Lost Formatting) ===
		+
		+	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]].
−	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.	+	=== Domain Already Renewed ===
−	===Partially Loaded Page (Blank or Lost Formatting)===	+	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 '''Additional Registrar Module Files Requirement''' section above for more info.	+	=== 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}}		{{modules}}

---

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:

1. Check to ensure that your server includes all required third-party classes (for example, PEAR). If it does not, see the section below.
2. Log in to the WHMCS Admin Area.
3. Go to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Products/Services > 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 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.