How to Integrate VPS Reseller Account with WHMCS

This article provides a guide for how to integrate VPS Reseller account with WHMCS. We will start by installing the WHMCS module for reselling VPS Servers. Follow the guide below to integrate VPS Reseller WHMCS module.

Prerequisites

  • WHMCS installation
  • VPS Reseller account
  • WHMCS server has ports 4081-4085 open

Install WHMCS VPS Module

  1. Download and extract the WHMCS integration [HERE].
  2. Copy the entire directory via FTP, SCP, etc. to /<WHMCS_PATH>/modules/servers/virtualizor_cloud/

Get API Credentials

  1. First, login to the VPS panel with your reseller account details.
  2. Access the side menu and navigate to “API Credentials”.
  3. Create a API Key Pair by clicking the button. Create api key pair
  4. API Key Pair success message will display upon successful creation.Api key pair created
  5. Copy the API key pair credentials (these will be needed to configure WHMCS server connection).Copy api key pair

Create Server in WHMCS Admin

Configure server in whmcs

  1. From WHMCS Admin > Setup > Products/Services > Servers
  2. Click “Add New Server”. Follow directions:
    1. Name: Can Be Anything
    2. Hostname: The Hostname of VPS Reseller
    3. IP Address: This will be provided by the data center.
    4. Nameservers are not required for this module
  3.  Server Details
    1. Module: “Virtualizor_cloud” .
    2. Username: API Key (created in previous step)
    3. Password: API Password (created in previous step)
    4. Access Hash: Leave empty

Create Product

Configure whmcs product

  1. Navigate to Setup > Products/Services > Products/Services.
  2. Select “Create a new Product
    1. Product Type: Server/VPS
    2. Product Group: Any
    3. Product Name: Any
  3. Go to “Module Settings” tab and enter the following details:
    1. Module: Virtualizor_cloud
    2. The remaining fields as described on that page
      Configure product module settings
  4. Go to “Custom Fields” and create new Custom Field with the following details:
    1. Field Name: vpsid (exactly as written)
    2. Field Type: Text Box
    3. Description: The ID of the server from VPS Panel. 
    4. Validation: Leave blank
    5. Check Admin Only tick box.

Product custom fields

Optional WHMCS Integration Customization

  • Create new VPS welcome email template. We have provided a custom email template to use for sending VPS server credentials to enduser when VPS is provisioned (created). This template will utilize merge fields and organize important server details better than the default “VPS/Dedicated Server Welcome Email” template  that is provided with WHMCS.
    • You can add the template from your WHMCS Admin area by navigating to “Setup->Email Templates”
    • Choose to “Create New Email Template”
    • Choose “Product/Service” from the “Email Type” drop-down menu and give the template a unique name
      Create custom vps welcome email template
    • Configure the email sending settings
    • Add a subject for your email (i.e. “New VPS Server Details”)
    • To import  our pre-made template, click “Enable/Disable Rich-Text Editor” button
    • Copy and paste the email template from below:
      Dear {$client_name},
      
      We are glad to inform you that the virtual machine you ordered has been set up.
      
      Manager Details
      =============================
      URL: https://your.master.domain.com:4083
      Username: {$service_username}
      Password: {$service_password}
      
      Server Details
      =============================
      Hostname: {$service_domain}
      Main IP: {$service_dedicated_ip} 
      Root Password: {$service_password}
      {if $service_assigned_ips}
      IP Address Allotted:
      {$service_assigned_ips}
      {/if}
      
      You can access your server over SSH. 
      If you are a Windows user, you can use a free SSH client called Putty which can be downloaded from :
      http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
      
      {$signature}
    • This is a basic template and you can easily customize or add additional details
  • Instead of creating each VPS product, with Custom Field: “OS|Operating System” and drop-down list of all available templates, we recommend creating a “Configurable Options” group with the  “OS\Operating System” configurable option.
    • Configurable Options group can be assigned to all VPS products (of the same Virtualization)-this will be much more desirable from an administrative perspective, should the available OS templates options ever change.
    • In the event of new OS template available for VPS, you can simply modify this single Configurable Option (assuming the group is assigned to multiple VPS products for same Virtualization), as opposed to editing the custom fields drop-down values for every related VPS product individually.
    • Where to get the values for available OS templates (for KVM virtualization VPS)?
      • Rad Web Hosting keeps a public list of available KVM OS templates in the Knowledgebase, at: VPS Guides -> List of Available OS Templates
      • Use the highlighted values (from the “Name” collumn) in the below image to for the Configurable Options “OS|Operating System” drop-down values (this must be exactly the same for the automated provisioning to work):
        List of available os templates

Client Area Features

Client area product details

WHMCS Admin Product Management

Whmcs admin product management

Leave a comment

Your email address will not be published. Required fields are marked *