Page tree
Skip to end of metadata
Go to start of metadata


This addon module will allow you to provision and sell CD-keys/Serial number using WHMCS's native system.

Key new features

  • Six+ template compatible

  • No template installation

  • 2 Types of Keys (Serial vs Login/Password)

  • ReCaptcha Anti-Scam support

The module is fully integrated with WHMCS native ordering system. Which means all you have to do to get it running is to

  1. Create a product under WHMCS

  2. Assign the Module of the created product to KeysProvider

  3. Select the price/welcome email/etc…

  4. Done !

The deployed keys are searchable with WHMCS native search for easy management

Requirements

Make sure you have the ioncube10 loader installed for your web server. If you are running ioncube 5 or earlier loader then you can either run easyapache to rebuild the ioncube extension automatically or download and modify the loader manually

Your WHMCS must be using a template that's build off of the six template engine as it utilizes the menu function.

Installation Instructions

Copy all the files into your WHMCS modules/addons directory. No template modification is needed

Language Files

The module includes English as the base language. If you wish to translate it to your enabled language in WHMCS. Make a copy of the english.php in /modules/addons/keysprovider/lang/ to your associated language. For example, french.php. The filename must match to the ones in the WHMCS/lang/french.php

Template Files

There are no template modification needed, if you wish to modify the Client area output, you can modify modules/servers/keysprovider/templates

Starting the module

Enable the module like you would for any other WHMCS module. WHMCS Admin → Setup → Addon Modules → Activate

Once activated you can set the options below

Modifying the email template

Upon installation of this module, a new email template will be installed onto your WHMCS. You can view and edit the template named WHMCS KeysProvider Template to your needs

Module Config Options

There are several options you can set with the mod. Here is a quick breakdown.

OptionExplanation
License KeyThe license key you obtained from us
API UserThis is needed if you are running WHMCS version less than 7.2. Otherwise, can leave blank.
Mask KeyThis option will mask the deployed key in the WHMCS → Services Listing. Eg. ABC-123-***. This is to prevent bot signups and obtaining the key
Masking OptionThe length of masking
Enable QR CodeEnable showing of QR Code
QR SizeThe width of the QR code size
Enable RecaptchaEnabling it will hide your keys behind the re-captcha verification. Customer must verify before being able to view the keys
Enable ValidationEnabling this will display the Validation options in the Admin side of the Service page. It will allow staff to Reset or Pass the validation
CheckMobi KeyIf using CheckMobi integration, you must have this key filled in. See CheckMobi Setup Instructions
Verify LimitThe number of times the customer is allow to verify a pin before they must contact support to get it reset
SMS/Phone Validation LimitThe number of times the customer can trigger the validation provider to send a pin to them before it's disabled
SMS/Phone Retry IntervalThe amount of time the customer must wait (in seconds) before they can trigger a re-send of the validation SMS/Call
Enable Out of Key EmailThis will send out an email to the customer when the Keys table is out.
Display My Keys MenuThis option will insert a new link in the Services Menu called My Cd-keys

  • No labels