Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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
Create a product under WHMCS
Assign the Module of the created product to KeysProvider
Select the price/welcome email/etc…
Done !
provide your customers with support pin numbers for easy verification.
Key Features
- 5 types of pin: (Main pin, 3rd party pin, temporary pin, Service Pin (1.30), Domain Pin (1.32))
- Variable length and pin combo (numeric vs alphanumeric)
- Adjustable pin code valid period
- Autogenerate when a code expires
- Easy to install, no template code modification needed
- WHMCS Six template compatible
- Easily translatable using WHMCS language files
- Display in the sidebar, navigation menu, homepage panel
- Allow customer to request temporary support pin (New in 1.34)
Main pin
is intended for all general purpose verification. Such as billing modification, account changes… etc
3rd party pin
is intended for the account holder providing account support access to a 3rd party individual without providing the main account. Such as contacting your company for support.
Temporary pin
is intended for providing quick verification if the account owner can't login but still have email access. Temporary keys are generated by your company staff and it is emailed to the customer's email
Service Pin
is intended for all purpose pin for a particular service a customer have
Domain Pin
is intended for all purpose pin for a particular domain a customer haveThe 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
earlierprior loader then you can either run easyapache to rebuild the ioncube extension automatically or download and modify the loader manually
Your WHMCSYou must be using a template that's build off of the six template engine as it utilizes the
menusidebar 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/keysprovidercustomerpin/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. The support pins will be displayed in the sidebar of the template.
Starting the module
Enable the module like you would for any other WHMCS module. WHMCS Admin → Setup → Addon Modules → Activate
Image Modified
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 needsCustomer Pin Template
Module Config Options
There are several options you can set with the mod. Here is a quick breakdown.
Option | Explanation |
---|---|
License Key | The license key you obtained from us |
API User | This is needed if you are running WHMCS version less than 7.2. Otherwise, can leave blank. |
Mask Key | This 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 Option | The length of masking |
Enable QR Code | Enable showing of QR Code |
QR Size | The width of the QR code size |
Enable Recaptcha | Enabling it will hide your keys behind the re-captcha verification. Customer must verify before being able to view the keys |
Enable Validation | Enabling 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 Key | If using CheckMobi integration, you must have this key filled in. See CheckMobi Setup Instructions |
Verify Limit | The number of times the customer is allow to verify a pin before they must contact support to get it reset |
SMS/Phone Validation Limit | The number of times the customer can trigger the validation provider to send a pin to them before it's disabled |
SMS/Phone Retry Interval | The 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 Email | This will send out an email to the customer when the Keys table is out. | Display My Keys Menu | This option will insert a new link in the Services Menu called My Cd-keys
Explaination | |
Request Pin Page | This will allow client to request temporary support pin for non-login validation |
Request Pin Time Interval | The number of seconds the client can request a temporary support pin email again |
Show Request Pin Link | This will insert a Request Support Pin link for non-logged in client to the Client Area |
Date display format | Change the display format for the pin expiry date |
Per Service Pin | Enable Service Support Pin |
Disable Per Account Pin | Enabling this will disable the Account Support Pin when Per Service Pin is enabled. Otherwise no effect |
Allow 3rd party support pin | This will enable the customer's ability to generate a 3rd party support code |
Main pin style | Set the main account's pin either numeric (0-9) or alphanumeric (A-z0-9) |
Main pin length | The length of the main pin |
Main pin valid duration | The number of days the pin is valid for until it get regenerated again |
Temp pin valid duration | The number of minutes the temporary pin is valid for (it will not regenerate, it is has to be sent manually) |
3rd party options | Same as the main pin options |
Email Template ID | The name the email template the module will use to send out the temporary pin (The name must be exact) |
Display options | These options will determine which template page the module will display on |
Request Pin Page
If your WHMCS template is not based on Six, then you can add a link manually to your template to link to the Request Pin Page
Code Block | ||
---|---|---|
| ||
index.php?m=customerpin&action=requestpin |
Table of Contents | ||||||
---|---|---|---|---|---|---|
|