Difference between revisions of "GlobalSign OneClickSSL"
From WHMCS Documentation
(→Setting Up Voucher Products) |
|||
| Line 1: | Line 1: | ||
| + | == About this Module == | ||
| + | |||
<div class="docs-alert-danger"> | <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. | |
| − | We recommend using the GlobalSign SSL module | ||
</div> | </div> | ||
| − | + | 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: | |
[[File:GSOneClickSSLClientArea.png]] | [[File:GSOneClickSSLClientArea.png]] | ||
| − | + | Admins can also view the option in your Admin Area: | |
[[File:GSOneClickSSLAdminArea.png]] | [[File:GSOneClickSSLAdminArea.png]] | ||
| − | == | + | == Configuring a Product == |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | To set up a OneClickSSL Voucher product: | |
| − | + | # Go to '''Setup > [[Products and Services|Products/Services]]'''. | |
| − | |||
| − | |||
| − | |||
| − | # | ||
# Create a new group for your GlobalSign SSL offerings. | # Create a new group for your GlobalSign SSL offerings. | ||
# Create a new product: | # Create a new product: | ||
| Line 58: | Line 45: | ||
#**'''SSL Certificate Type''' — Set the type of SSL product this voucher grants access to (''DomainSSL'' or ''AlphaSSL''). | #**'''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). | #**'''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''). | + | #**'''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. | #**'''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. | ||
| + | |||
| + | [[File:GSOneClickSSLModuleSettings.png]] | ||
| − | + | === Configurable Options === | |
| − | [[ | + | 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. |
| + | |||
| + | 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: | |
| − | + | # [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. | ||
Revision as of 17:55, 13 May 2022
Contents
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.