WHMCS - SSLCert Provisioning Addon

Introduction

WHMCS Provisioning Module and Addon for HEXONET & CentralNic Reseller SSL certificates.

The CNIC SSL Module is a combination of an addon and a provisioning module.

The SSL addon provides a user friendly interface to automatically import SSL certificates as WHMCS products. In addition, it gives the possibility to update prices based on current cost and configurable margins.

The SSL provisioning module connects to the configured registrar module and allows you to register and maintain SSL certificates over HEXONET or CentralNic Reseller.

Supported Features

The CNIC SSL Module supports the following functions and features:

• Support for our Brands: HEXONET and CentralNic Reseller
• SSL Provisioning Module
  • Support for both productive and test (OT&E) environments
  • Create, renew and revoke certificates
  • Support for Email, DNS and File based domain validation methods
• SSL addon
  • Import available SSL certificates
  • Bulk price update by using a profit margin
  • Multicurrency support
  • Import product logos and descriptions
  • Unified handling of different certificate providers

Requirements

In our system requirements, we recommend avoiding PHP versions that have reached their End of Life (EOL), as indicated in red on the PHP Supported Versions page.

To ensure compatibility with WHMCS, please follow these steps:

• Check the supported PHP versions for your desired WHMCS version using our WHMCS/PHP Matrix.
• Determine the required IonCube Loader version for your WHMCS version from the WHMCS/IonCube Loader Matrix.
• Identify the compatible MySQL version for your chosen WHMCS version using the WHMCS/MySQL Matrix.

Ensure to have the below packages installed on your WHMCS Server:

• curl
• php-curl
• For HEXONET:
  • Latest ISPAPI Registrar Module. This module can be downloaded here. Our SSL Cert Module does not support the WHMCS built-in HEXONET provider module!
  • HEXONET Live or Test Account must be configured in the ISPAPI Registrar Module. Account creation is always free:
    • OT&E (Test System) Account
    • LIVE (Real World System) Account
• For CentralNic Reseller:
  • Latest CentralNic Reseller Registrar Module. This module can be downloaded here. Our SSL Cert Module does not support the WHMCS built-in CentralNic Reseller provider module!
  • CentralNic Reseller Live or Test Account must be configured in the CentralNic Reseller Registrar Module. Account creation is always free: Register

Please note: We ensure compatibility with the latest WHMCS version and the maximum versions of the listed software dependencies. While our modules may still function with older PHP versions like PHP 7.4, we don’t provide support for them and cannot guarantee their continued compatibility. If you have questions or need assistance, please reach out to us.

Grant User Permissions

• Log in to the CentralNic Reseller Control Panel (OT&E, LIVE).
• Click on your username located at the top right corner.
• Choose 'User management' from the dropdown menu.
• Click on the user associated with your WHMCS system to configure their permissions.
• Assign the following read, write and delete permissions:
  • Certificate (for CNIC SSL Addon)

Please ensure that the specified permissions are granted to the user linked with your WHMCS system.

Installation / Upgrade

Read the article "WHMCS - Module Installation & Upgrade". We are shipping all Modules as part of our Software Bundle.

SSL Addon

Addon Activation

Navigate to WHMCS Admin Area > System Settings > Addon Modules

1. Activate the CNIC SSL Addon
2. Choose the registrar you want to use (additional module and accounts required! see Requirements)
3. Give the module “Full Administrator” Access Control right.
4. Save changes

You are now ready to create SSL certificate products in WHMCS. You can do so manually, or automatically by using our convenient addon.

Automatic Product Import & Pricing Sync

This will allow you to import any desired certificate as WHMCS product. Any existing product will be updated with current information.

1. Open the CNIC SSL Addon in the WHMCS Admin Area.
2. Fill out the form to your liking.
   • Margin type: Percentage or Fixed Amount.
   • Profit margin: percentage value or amount in your default currency.
   • Round to Next: select the desired rounding value.
   • Apply rounding to all currencies: if active, the rounding will be applied to the prices for currencies.
   • Automatic Registration: select the desired automatic registration behavior for the products.
   • Generate product descriptions: this will add provider logos and feature highlights to the imported products. The recommended Order Form Template to leverage this information is Supreme Comparison.
   • Generate product groups: this will create one product group per certificate provider with group features. If disabled, all products will be assigned to the same product group. Existing products are not affected.
3. Tick the checkboxes on the products you wish to import or update.
4. Press the Import button. Existing products will be updated, missing products will be automatically created.

Managing SSL Products

Product management can be handled automatically by using the SSL Addon. However it is possible to do so manually, if desired.

Manually create Products

Within the WHMCS Admin area, navigate to Setup > System Settings > Products/Services

1. Create a new product group. In this example, we will name the new group as “SSL Certificates”.
2. Create a new product.
   • Set Product Type to “Other”.
   • Set Product Group as desired.
   • Define a product name.

Select CNIC SSL Certificate as Module.

1. Open the Details tab.
   • Set a Product Description (optional).
   • Ensure the Welcome Email field is set to “None” as the module sends its own email.

Ensure the Required Domain field is unchecked.

1. Open the Pricing tab.
   • Set the Payment Type field to Recurring.

Set an annual price.

1. Open the Module Settings tab.
   • Enter Certificate Class.
     • For HEXONET: refer to this article for a list of possible certificate classes
     • For CentralNic Reseller:
       1. Log into your Web Interface
       2. In the Menu, open SSL > Certificate Prices
       3. The value shown in the Type column would be the certificate class you need to specify

Set “Automatically setup the product as soon as the first payment is received” to ensure the certificate is paid for before registration.

1. Click Save changes.

Manage imported Prices

Managing imported certificates can be done at Setup > System Settings > Products/Services

Customer Experience

Client Area

You can check the product groups in the store in your WHMCS Client Area. If you used our Addon to import Product Groups and Products, you will see those pages already configured with a comparison cart, product features, certificate provider logos and so on. You are basically ready to go!

Certificate Ordering Process

This is how a client would proceed to order an SSL certificate.

1. Go to the created certificate group on your WHMCS Client Area and “Order Now” the desired certificate.
2. Follow the steps in the buying process.
3. Once the invoice is paid, you will receive an SSL certificate Configuration email, which contains a link to configure the new certificate.

Click this link or to go to the bought SSL certificate product page and click the “Configure SSL Certificate” button.

On this configuration page, the module will prefill the contact information and auto generate a CSR based on the domain provided and your client information. At this point, you are free to alter any information and replace the proposed CSR with your own if you wish.

On the subsequent configuration page, you will be asked for a Certificate Approver Email. Alternatively, you can choose the DNS or HTTP File validation methods, if available (not all certificates support all validation methods).

The configuration is now completed

1. Follow the instructions you will get via e-mail from the Certificate Authority to validate your purchase. If you chose DNS or HTTP File validation, just follow the instructions that are presented to you in the confirmation screen.
2. It might take some minutes after validation until the certificate shows up in the client area

Automatic SSL Configuration & Installation

1. Attempt Automatic Config
   For certificates requiring DNS or FILE validation, the addon will attempt to automatically create the necessary DNS records or validation files. It checks for existing hosting packages on Plesk, cPanel, or DirectAdmin for the relevant domains. This feature simplifies the validation process.
2. Attempt Automatic Install
   After the SSL certificate is issued, you can install it with one click. The addon searches for existing hosting packages on Plesk, cPanel, or DirectAdmin. The certificate will be installed on these servers automatically.

   Note: Automatic uploading of the CA certificate is not currently supported.

Key Features:

• DNS & File-Based Validation Automation: The addon handles validation setups seamlessly on supported servers, reducing manual configuration.
• One-Click Certificate Installation: Once the certificate is ready, installation can be done easily across supported hosting environments.