Difference between revisions of "ResellerClub SSL"

From WHMCS Documentation

m (→‎Multiple Years)
(→‎Testing)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
ResellerClub offers thawte's Digital Certificates - part of the Verisign group, which is one of the most trusted brands in the world.
+
ResellerClub offers thawte's Digital Certificates as part of the Verisign group, one of the most trusted brands in the world.
  
−
With WHMCS, SSL ordering and provisioning is '''fully automated'''. SSL Products you setup are ordered in the same way as everything else via the shopping cart. No SSL specific configuration is performed actually during the order process, to keep the ordering process simple and ensure conversions aren't lost due to barriers with the SSL setup process.
+
With WHMCS, SSL ordering and provisioning is fully automated. SSL products that you set up are ordered in the same way as everything else via the shopping cart. No SSL-specific configuration is performed actually during the order process, to keep the ordering process simple and ensure conversions aren't lost due to barriers with the SSL setup process.
  
 
So instead, once an order has been placed and paid for, the customer is then sent an email containing a link which takes them to configure the certificate directly on your website.  This is a very simple 2 step process that they are guided through, where the client never leaves your site, and once all details have been provided, the configuration data is sent to the Certificate Authority in the background via the module and API, and a short while later, the completed certificate gets emailed directly to the client.  From start to finish, no actions are required from your side so it really is a very simple addition to your product portfolio.
 
So instead, once an order has been placed and paid for, the customer is then sent an email containing a link which takes them to configure the certificate directly on your website.  This is a very simple 2 step process that they are guided through, where the client never leaves your site, and once all details have been provided, the configuration data is sent to the Certificate Authority in the background via the module and API, and a short while later, the completed certificate gets emailed directly to the client.  From start to finish, no actions are required from your side so it really is a very simple addition to your product portfolio.
Line 7: Line 7:
 
==Setting up an SSL Product==
 
==Setting up an SSL Product==
  
−
To create a ResellerClub SSL product, simple follow the steps below:
+
To create a ResellerClub SSL product:
  
−
#Begin by creating a product as normal in '''Setup > Products & Services'''
+
#Create a product at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
 
#Set the product type to '''Other Product/Service'''
 
#Set the product type to '''Other Product/Service'''
−
#Specify a name of your choice, description, and disable the domain options by ensuring "Require Domain" is deselected
+
#Specify a name and description.
−
#Leave the Welcome Email set to None - with SSL Products the SSL Configuration Required email template is sent automatically with a link to configure the certificate as soon as the order is processed & activated
+
#Deselect '''Require Domain'''.
−
#Next navigate to the '''Module Settings''' tab and from there select the "Resellerclubssl" module (if you do not see this option, please double check the installation steps were performed correctly above)
+
#Set '''Welcome Email''' to ''None''. For SSL products, the system sends the ''SSL Configuration Required'' email template automatically with a link to configure the certificate as soon as it processes and activates the order.
−
#After selecting this, the page will reload showing the ResellerClub SSL related config options - these are your Reseller ID, Password, Certificate Type & Test Mode
+
#Go to the '''Module Settings''' tab and select "Resellerclubssl". If you do not see this option, check whether you performed the installation steps correctly. The page will reload and display the ResellerClub SSL-related configuration options ('''Reseller ID''', '''Password''', '''Certificate Type''', and '''Test Mode''').
−
#You can find your Reseller ID by navigating to '''Settings > Personal Information > Primary Profile''' within your ResellerClub account, or if you already use the ResellerClub Domains module within WHMCS it can be found by navigating to '''Setup > Domain Registrars > ResellerClub'''
+
#To find your reseller ID:
−
#If you don't yet have a ResellerClub account, please visit http://www.whmcs.com/partners/resellerclub
+
#* If you already have a ResellerClub account, go to '''Settings > Personal Information > Primary Profile''' within your ResellerClub account.
−
#If this is your first time using the ResellerClub API, you also need to register your server IP address with ResellerClub.  To do this, login to the ResellerClub control panel and then go to '''Settings > API''' and enter the IP where your WHMCS is installed there. ''Please Note: It can take up to 30 minutes for the IP to be allowed on their system.''
+
#* If you already use the ResellerClub Domains module in WHMCS, you can also go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Domain Registrars''' and check the '''ResellerClub''' configuration.
−
#A custom field will be automatically created with a field called "Domain Name" where the customer is required to enter the domain name the SSL Certificate is for as part of the order process. You can customise this field via the '''Custom Fields''' tab, but if customising the name you must do so in the format "Domain Name|Your Custom Name Here" so that WHMCS can still recognise the field.
+
#* If you don't yet have a ResellerClub account, [http://www.whmcs.com/partners/resellerclub create one].
−
#And that's it, you're ready to try it out!
+
#If this is your first time using the ResellerClub API, you need to register your server's IP address with ResellerClub.  To do this, log in to the ResellerClub control panel, go to '''Settings > API''', and enter the IP address for your WHMCS installation. It can take up to 30 minutes for the ResellerClub system to allow the IP address after you enter it.
 +
 
 +
ResellerClub will automatically create a custom '''Domain Name''' field in which the customer must enter the SSL certificate's domain name during the order process. You can customise this field in the '''Custom Fields''' tab, but you must use the format "Domain Name|Your Custom Name Here" so that WHMCS can still recognise the field.
  
 
===Pricing===
 
===Pricing===
  
−
When offering SSL Certificates, you have 2 choices - you can offer them as either '''one time''' products, '''or recurring''' products. We recommend using '''recurring''', as then you benefit from the '''automatic invoicing and renewals''' at the end of the current subscription period. So to configure that you would simply select "Recurring" as the Payment Type on the Pricing tab of the product config, and set the prices for Annual and Biennial billing cycles (1 and 2 Years respectively) since those are the only terms ResellerClub support for SSL Certificates at this time.
+
When offering SSL certificates, you can offer them as either one time products or recurring products. We recommend recurring products because they allow you to use automatic invoicing and renewals at the end of subscription periods. To configure this, select ''Recurring'' for '''Payment Type''' in the '''Pricing''' tab for the product. Set the prices for '''Annual''' and '''Biennial''' billing cycle; they are the only supported terms.
  
−
Alternatively, if you are just wanting to offer certificates for a period of 1 year at a time, then you can set them up as either Recurring with just the Annual billing cycle defined with a price, or even as a One Time product to have no automated renewals occur.
+
Alternatively, to offer certificates for only one year, set them as either ''Recurring'', defining only the '''Annual''' billing cycle, or as a ''One Time'' product if you do not want automated renewals.
  
−
===Multiple Years===
+
==Testing==
−
It is also possible to use a Configurable Option to allow clients to choose how long the certificate is registered for (either 1 or 2 years at this time). To do this you set the product up as normal with a one time cycle and base price of zero. 
 
−
 
 
−
Setup a [[Addons_and_Configurable_Options|Configurable Option Group]] in the normal way and add an option named "Years" with a dropdown of the year options and prices in the monthly field. 
 
−
 
 
−
That then shows on the product configuration screen for the user to choose from when ordering and the price charged is the value of the option selected.
 
  
−
For example your configurable option might look like this:
+
If you want to use '''Test Mode''', you '''must''' create a separate account on ResellerClub's dedicated testing environment.
  
−
[[File:Resellerclubsslyearsoption.png]]
+
* This is completely separate from the live system.  
−
 
+
* You cannot use your live account details for testing. 
−
==Testing==
 
  
−
If you want to use the test mode, you '''must''' create a separate account on ResellerClub's dedicated testing environment. This is completely separate from the live system and you cannot therefore use your live account details for testing.  For instructions on how to do this, please refer to ResellerClub's Knowledgebase @ http://manage.resellerclub.com/kb/servlet/KBServlet/faq415.html
+
For more information, see [http://manage.resellerclub.com/kb/servlet/KBServlet/faq415.html ResellerClub's Knowledgebase].
  
 
<div class="docs-alert-info">
 
<div class="docs-alert-info">
−
<span class="title">Note:</span><br />
+
The module's '''Create''' does not generate a username and password. The username and password will be blank in the client's '''[[Clients:Products/Services Tab|Products/Services]]''' tab.
−
The module create function of this module does not generate a username and password by design. Therefore the username/password fields will be blank under the client's Products/services tab.
 
 
</div>
 
</div>

Latest revision as of 15:23, 3 May 2022

ResellerClub offers thawte's Digital Certificates as part of the Verisign group, one of the most trusted brands in the world.

With WHMCS, SSL ordering and provisioning is fully automated. SSL products that you set up are ordered in the same way as everything else via the shopping cart. No SSL-specific configuration is performed actually during the order process, to keep the ordering process simple and ensure conversions aren't lost due to barriers with the SSL setup process.

So instead, once an order has been placed and paid for, the customer is then sent an email containing a link which takes them to configure the certificate directly on your website. This is a very simple 2 step process that they are guided through, where the client never leaves your site, and once all details have been provided, the configuration data is sent to the Certificate Authority in the background via the module and API, and a short while later, the completed certificate gets emailed directly to the client. From start to finish, no actions are required from your side so it really is a very simple addition to your product portfolio.

Setting up an SSL Product

To create a ResellerClub SSL product:

  1. Create a product at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services.
  2. Set the product type to Other Product/Service
  3. Specify a name and description.
  4. Deselect Require Domain.
  5. Set Welcome Email to None. For SSL products, the system sends the SSL Configuration Required email template automatically with a link to configure the certificate as soon as it processes and activates the order.
  6. Go to the Module Settings tab and select "Resellerclubssl". If you do not see this option, check whether you performed the installation steps correctly. The page will reload and display the ResellerClub SSL-related configuration options (Reseller ID, Password, Certificate Type, and Test Mode).
  7. To find your reseller ID:
    • If you already have a ResellerClub account, go to Settings > Personal Information > Primary Profile within your ResellerClub account.
    • If you already use the ResellerClub Domains module in WHMCS, you can also go to Configuration () > System Settings > Domain Registrars or, prior to WHMCS 8.0, Setup > Domain Registrars and check the ResellerClub configuration.
    • If you don't yet have a ResellerClub account, create one.
  8. If this is your first time using the ResellerClub API, you need to register your server's IP address with ResellerClub. To do this, log in to the ResellerClub control panel, go to Settings > API, and enter the IP address for your WHMCS installation. It can take up to 30 minutes for the ResellerClub system to allow the IP address after you enter it.

ResellerClub will automatically create a custom Domain Name field in which the customer must enter the SSL certificate's domain name during the order process. You can customise this field in the Custom Fields tab, but you must use the format "Domain Name|Your Custom Name Here" so that WHMCS can still recognise the field.

Pricing

When offering SSL certificates, you can offer them as either one time products or recurring products. We recommend recurring products because they allow you to use automatic invoicing and renewals at the end of subscription periods. To configure this, select Recurring for Payment Type in the Pricing tab for the product. Set the prices for Annual and Biennial billing cycle; they are the only supported terms.

Alternatively, to offer certificates for only one year, set them as either Recurring, defining only the Annual billing cycle, or as a One Time product if you do not want automated renewals.

Testing

If you want to use Test Mode, you must create a separate account on ResellerClub's dedicated testing environment.

  • This is completely separate from the live system.
  • You cannot use your live account details for testing.

For more information, see ResellerClub's Knowledgebase.

The module's Create does not generate a username and password. The username and password will be blank in the client's Products/Services tab.

Retrieved from "http://3.17.75.209/index.php?title=ResellerClub_SSL&oldid=32504"