We have great news for our VPSServer customers! We have been busy creating a new WHCMS plugin for our API which has launched for 2021.
With this upgrade, white labelling our services and products just got even easier. The WHCMS provisioning module for our API will integrate your server management with your WHMCS billing system seamlessly. In this post, we're going to unpack the benefits and features supported via the plugin to help you get the most out of it, with steps on how to install it.
Benefits of the WHMCS plugin for the VPSServer API
The official VPSServer.com provisioning module for WHMCS has been designed to allow web hosting billing automation tool WHMCS to synchronise with the VPSServer system.
With the API installed, you can easily outsource our server products, combining web hosting, server management and billing functionality all in one place. The WHMCS module can handle all financial transactions, including new order payments, overdue billing and notices, renewals and cancellation requests, as well as a host of other features including plan upgrades and downgrades, admin functionality (password resets), and metrics.
Thanks to the custom features we have added, you and your clients will be able to access all WHMCS provisioning functionalities performed on virtual servers, including key Create, Terminate, Suspend, Unsuspend and Upgrade/Downgrade actions. But it doesn't end there, end-users will also have access to tools that enable them to easily manage servers and monitor real-time statistics, as well as perform a range of actions, all without exiting the client area.
Let's take a look at the client and admin features in more detail...
Client area features
Below we explore some of the main functions in the client area of the VPSServer API supported by the new WHMCS module:
Power On/Power Off/Reboot/Reboot in Recovery Mode Server - Thanks to the intuitive design of our API, your customers can easily power on/off specific servers or reboot/reboot their servers in recovery mode simply by pressing the corresponding buttons.
Change Server Password - Clients can easily make servers more secure by updating their passwords themselves as part of regular maintenance or for damage limitation if there has been a suspected security breach.
Change Server Hostname - Under the Manage Server section, your clients can rename their hostname to differentiate two or more servers, for maintenance, performance checking and running tests.
View Server Status And Details - Clients can see for themselves how their servers are performing with real-time metrics on server status and notes.
View/Add/Move/Delete Server Firewalls - In the Firewalls section, clients can keep on top of server security by reviewing all individual server firewall rules, as well as adding new firewall rules or modifying any existing ones simply.
View/Add/Restore/Delete Server Back-Ups - Server back-ups are faster and simpler than ever to perform, all at the click of a button. Clients can also add, edit, restore, and remove them with ease.
View/Add/Edit/Delete Server Back-Up Schedules - The Back-ups Management area of the module also allows clients to create and edit back-up schedules based on duration and rotation periods, as well as to run at specific times, making back-up automation a cinch.
View/Add/Edit/Delete Server SSH keys - Clients can easily manage all users' SSH keys, including adding, editing and removing any no longer required.
View Server Statistics Graphs - There are a range of insights available to view in the Graphs section of the module, with the main functions displaying server bandwidth, CPU %, Average IO per second, and Average disk data for quick and easy reference.
Clients also have the ability to manage and customise their servers directly through setting defined configurations when setting up servers. These can be set in accordance with:
Location - they can choose a location for each server from a list
Template - they can define the system that will be installed on the server
Product - they can select a product from the list that is to be used
If no configurations are set, the default parameters will be used.
Admin area features
From the admin area of the module, it's easy to monitor the performance and status of your servers, as well as run key actions on your customers' virtual machines. You can also view and edit the configurations for the server you sell and module commands set by yourself or clients for easy supervision and management where required. As above, if no configurations are selected, the default parameters will be used instead.
Below is an overview of the main functionalities in the admin area of the VPSServer API:
Create/Terminate Server - Easily create any new servers you want to add to your group or remove any you or your client no longer need.
Block/Unblock Server Management - Create custom commands for blocking or unblocking specific IP addresses and websites from your server.
Upgrade/Downgrade Server - Manage the settings and plans for each server according to your needs with integrated and streamlined billing handled by WHMCS.
View Server Status And Details - Analyse real-time metrics to get insights into your current server status and break down the results so you can keep things moving.
View Server Statistics Graphs - See the usage across your server, including bandwidth, CPU, Average IO per second and Average disk data.
Run API Connection Test - Add your API Token and run a check to ensure the strength and accuracy of the connection between your server and the API (steps below).
How to install the WHMCS module
If you want to install the WHMCS plugin for the VPSServer API, follow the steps below:
1. Log in to the VPSServer client area and click to download the WHMCS module.
2. Upload and extract the extension into the main WHMCS directory.
3. Next, generate your VPSServer API Token so that it can connect with the server (located in the API section of your VPSServer account).
4. In the ‘Tokens’ section click ‘Add API Token’.
5. Provide a label and press the ‘Add Token’ button.
6. Copy the generated ‘API Token’and make a note since it will not show again.
7. Log in to your WHMCS account and navigate to 'System Settings' > 'Servers' > click 'Add New'.
8. Press 'click here' to switch from the new server creation wizard to the previous wizard.
9. Now add your server name and in the ‘Server Details’ section, choose ‘VPS Server’ from the ‘Module’ field. Here you will need to enter your ‘API Token’ in the ‘Password’ field. Save changes.
10. Click ‘Create New Group’, then add a name, click on your previously created server, press 'Add' and save changes.
11. To create and configure a product, go to 'System Settings' > 'Products/Services' > click ‘Create a New Group’. Then enter a name and save changes.
12. Once you have a product group, you can create a new product. Then you can choose your product type, enter your product name, choose a module and the product group from the drop-down menus. Next, press 'Continue'.
13. In the 'Module Settings' section you can select your previously created server group from the drop-down menu.
14. Finally, you can start configuring the settings of your servers.
The new WHCMS plugin for the VPSServer API is set to make managing your own and client servers and billing more straightforward than ever. For more advice on getting set up, contact us today. We'll be happy to answer any questions.