Difference between revisions of "GlobalSign OneClickSSL"

Latest revision as of 17:14, 28 December 2022

About this Module

GlobalSign discontinued OneClick SSL on Tuesday, February 6th, 2018. We no longer distribute this module and it will no longer function.

For more information, see GlobalSign's website.
We recommend using the GlobalSign SSL module instead.

This module automates the SSL reselling & installation process. Users simply activate SSL for their website by redeeming Secure Site vouchers via any of the OneClickSSL plug-ins, available via platforms such as cPanel, Parallels, IIS, and Apache.

Redemption of the voucher using the plug-in transparently creates the cryptographic keys, the Certificate Signing Request (CSR), validates the control of the domain, installs the issued certificate, and binds it to the appropriate website. This eliminates the need to provide your customer with a CSR and have them go through a lengthy and often confusing SSL configuration process.

WHMCS lets you take full advantage of the OneClickSSL automation by allowing your customers to purchase and receive their OneClickSSL Vouchers automatically from your WHMCS installation. This includes:

Fully-automated voucher provisioning.
Support for DomainSSL and AlphaSSL products.
Registration periods up to five years.
Support for SSL transfers.

Display

Customers will see the option to purchase vouchers in your Client Area:

Admins can also view the option in your Admin Area:

Configuring a Product

To set up a OneClickSSL Voucher product:

Go to Setup > Products/Services.
Create a new group for your GlobalSign SSL offerings.
Create a new product:
- Select the newly-created group.
- Set the product type to Other.
- Disable Require Domain.
- Select None for Welcome Email.
- Select One-Time for Payment Type.
- Select Globalsignvouchers as the module.
- Configure the following additional module settings:
  - Username & Password — Enter your GlobalSign API credentials.
  - SSL Certificate Type — Set the type of SSL product this voucher grants access to (DomainSSL or AlphaSSL).
  - Validity Period — Set the period for which the SSL certificate should be valid (for example 1 year, 2 year, or 3 year).
  - Order Kind — Set the type of order this product is for (New or Transfer). Usually, you will select New.
  - Coupon & Campaign — Only use these fields if GlobalSign support instructs you to.
Optionally, go to Setup > Custom Client Fields and customize the display name following Domain| on the system-created custom field for this module.

Configurable Options

You can offer voucher products in many combinations. To do this, you can create configurable options to override the default module settings based on customer selections.

You can create configurable options using the following names:

NumYears — This option will override the validity period for a product. This allows you to offer one year through five year registration periods via a single product instead of creating a separate product for each validity period.
Transfer — If you set this option to use Yes/No, it allows the customer to specify whether the SSL certificate that they are ordering is a transfer of an existing SSL certificate.

Installation for WHMCS 4.5 or Earlier

We started shipping this module by default in WHMCS 5.0.2. For WHMCS 4.5 or earlier, you will need to download and install the module before you can use it.

To download this module:

Download the module.
Unzip the file.
Upload the module folder to the /modules/servers/ directory in your WHMCS installation.
Contact GlobalSign support and request that they whitelist your IP address for access to their API. If you do not do this, you will see a This IP Address is not registered error.

Troubleshooting

N/A

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: @@
-Welcome to OneClickSSL, GlobalSign's revolutionary new SSL technology for automating the SSL reselling & installation process.
+== About this Module ==
-Never liking to be far behind the latest technological advances, here at WHMCS we're proud to be '''the first''' billing solution offering integration with GlobalSign's new service, putting WHMCS users ahead of all the competition!
+<div class="docs-alert-danger">
+GlobalSign discontinued OneClick SSL on Tuesday, February 6th, 2018. We no longer distribute this module and it will no longer function.
+* For more information, see [https://support.globalsign.com/customer/portal/articles/2428257 GlobalSign's website].
+* We recommend using the [[GlobalSign SSL]] module instead.
+</div>
-==What is it?==
+This module automates the SSL reselling & installation process. Users simply activate SSL for their website by redeeming Secure Site vouchers via any of the OneClickSSL plug-ins, available via platforms such as cPanel, Parallels, IIS, and Apache.
-With OneClickSSL, users simply activate SSL for their website by redeeming Secure Site vouchers via any of the OneClickSSL plug-ins, available via platforms such as cPanel, Parallels, IIS, and Apache.
+Redemption of the voucher using the plug-in transparently creates the cryptographic keys, the Certificate Signing Request (CSR), validates the control of the domain, installs the issued certificate, and binds it to the appropriate website. This eliminates the need to provide your customer with a CSR and have them go through a lengthy and often confusing SSL configuration process.
-Redemption of the voucher using the plug-in transparently creates the cryptographic keys, the Certificate Signing Request (CSR), validates the control of the domain, installs the issued certificate and binds it to the appropriate website, all within just a few seconds, thus eliminating the need to provide your customer with a CSR, and have them go through a lengthy and often confusing SSL configuration process.
+WHMCS lets you take full advantage of the OneClickSSL automation by allowing your customers to purchase and receive their OneClickSSL Vouchers automatically from your WHMCS installation. This includes:
-But where does the user get the OneClickSSL Voucher you're wondering? Well that's where WHMCS comes in.  WHMCS lets you take full advantage of the OneClickSSL automation by allowing your customers to purchase and receive their OneClickSSL Vouchers automatically from your very own WHMCS ordering system.
+* Fully-automated voucher provisioning.
+* Support for DomainSSL and AlphaSSL products.
+* Registration periods up to five years.
+* Support for SSL transfers.
-Here's an example of how a voucher purchase is shown to the customer via your client area:
+=== Display ===
+Customers will see the option to purchase vouchers in your Client Area:
 [[File:GSOneClickSSLClientArea.png]]
-And for admin users:
+Admins can also view the option in your Admin Area:
 [[File:GSOneClickSSLAdminArea.png]]
-==Features==
+== Configuring a Product ==
+To set up a OneClickSSL Voucher product:
-*Fully Automated Voucher Provisioning
+# Go to '''Setup > [[Products and Services|Products/Services]]'''.
-*Supports both DomainSSL & AlphaSSL Products
+# Create a new group for your GlobalSign SSL offerings.
-*Allows offering Registration Periods of up to 5 Years
+# Create a new product:
-*Support for SSL Transfers
+#* Select the newly-created group.
-*Automatic Rebilling & Renewals (Up to a max of 3 Year Cycles)
+#* Set the product type to '''Other'''.
+#* Disable '''Require Domain'''.
+#* Select ''None'' for '''Welcome Email'''.
+#* Select '''One-Time''' for '''Payment Type'''.
+#* Select ''Globalsignvouchers'' as the module.
+#* Configure the following additional module settings:
+#**'''Username & Password''' — Enter your GlobalSign API credentials.
+#**'''SSL Certificate Type''' — Set the type of SSL product this voucher grants access to (''DomainSSL'' or ''AlphaSSL'').
+#**'''Validity Period''' — Set the period for which the SSL certificate should be valid (for example 1 year, 2 year, or 3 year).
+#**'''Order Kind''' — Set the type of order this product is for (''New'' or ''Transfer''). Usually, you will select ''New''.
+#**'''Coupon & Campaign''' — Only use these fields if GlobalSign support instructs you to.
+# Optionally, go to '''Setup > [[Custom Fields|Custom Client Fields]]''' and customize the display name following '''Domain|''' on the system-created custom field for this module.
-==Installation==
+[[File:GSOneClickSSLModuleSettings.png]]
-The GlobalSign OneClickSSL module first became available in August 2011 and so is not included by default in any WHMCS releases prior to V4.6. Therefore if you are running on Version 4.5 of WHMCS or earlier, you will need to download and install the module before you can use it. To download simply follow the link below and then to install, it's simply a case of uploading the module folder within the zip file to the /modules/servers/ directory of your installation.
+=== Configurable Options ===
- http://www.whmcs.com/members/dl.php?type=d&id=90
+You can offer voucher products in many combinations. To do this, you can create [[Configurable Options|configurable options]] to override the default module settings based on customer selections.
-==Setting Up Voucher Products==
+You can create configurable options using the following names:
-To configure a OneClickSSL Voucher product in WHMCS, simply follow the steps below:
+* '''NumYears''' — This option will override the validity period for a product. This allows you to offer one year through five year registration periods via a single product instead of creating a separate product for each validity period.
+* '''Transfer''' — If you set this option to use '''Yes/No''', it allows the customer to specify whether the SSL certificate that they are ordering is a transfer of an existing SSL certificate.
-# Begin by navigating to '''Setup > Products/Services''' and create a new group for your GlobalSign SSL offerings
+== Installation for WHMCS 4.5 or Earlier ==
-# Next proceed to create a new product, selecting the group you just created above, setting the product type to "Other" and giving the new product a name
-# You can then configure the description and other settings as you would for any product
-# '''Require Domain''' should be unticked. And '''Welcome Email''' should be left at None.
-# When it comes to pricing, you can either offer the voucher for a one time cost, therefore without any automated renewals, or up to a maximum of 3 Years (Triennial) you can configure the voucher to automatically recur and renew using the recurring pricing options in WHMCS
-# Now it's time to configure the GlobalSign related settings via the '''Module Settings''' tab
-# Begin by choosing '''Globalsignvouchers''' from the module dropdown menu
-# You'll then be presented with a screen like the one below which has the following fields:
-*'''Username & Password''' - this is where you need to enter your GlobalSign API Username & Password
+We started shipping this module by default in WHMCS 5.0.2. For WHMCS 4.5 or earlier, you will need to download and install the module before you can use it.
-*'''SSL Certificate Type''' - in this dropdown menu you can set the type of SSL product this voucher grants access to. The choices are DomainSSL or AlphaSSL.
-*'''Validity Period''' - this is where you set the period the SSL Certificate should be valid for if selling it as a One Time Product. If you are using recurring billing cycles then the Annual, Biennial or Triennial billing cycles will override this as appropriate.
-*'''Order Kind''' - this is where you set the type of order this product is for. The choices are New, Transfer or Renewal. Normally you should choose New here.
-*'''Coupon & Campaign''' - these are optional fields which are only to be used if specifically instructed to by GlobalSign support
-*'''Test Mode''' - this checkbox allows you to toggle demo mode for the selected product to allow you to place test orders without being charged
-One final requirement for the Voucher products is that a custom field must be created for the customer to enter the domain they are purchasing the voucher for. This will be created automatically for you but you can customise the display name which is the part after the '''Domain|''' via the custom fields tab should you wish.
+To download this module:
-[[File:GSOneClickSSLModuleSettings.png]]
+# [http://www.whmcs.com/members/dl.php?type=d&id=90 Download the module.]
+# Unzip the file.
+# Upload the module folder to the <tt>/modules/servers/</tt> directory in your WHMCS installation.
+# Contact GlobalSign support and request that they whitelist your IP address for access to their API. If you do not do this, you will see a ''This IP Address is not registered'' error.
-==Additional Options==
+== Troubleshooting ==
-Voucher products can be offered in many different ways and combinations. And so in the module for WHMCS we've tried it make it as flexible as possible. And so to that end, there are a number of optional configurable options you can create to override the default module settings based on customers selections if you wish:
+''N/A''
-*'''NumYears''' - A configurable option with this keyword name will override the Validity Period set for a product thus allowing you to offer the 1-5 registration periods via a single product
+{{modules}}
-*'''Transfer''' - If you setup a configurable option with this name, set to field type Yes/No, then this allows the customer to specify if the SSL they are ordering is a transfer of an existing SSL simply by checking a box in the order process

Documentation