WHMCS Module v2

This module allows WHMCS to interact with GSP-Panel using the WebAPI to auto-provision game servers.

The following WHMCS functions work in this module:

This is NOT a drop-in replacement for our older modules and will require you to reconfigure your WHMCS products if you wish to upgrade to this one.

Installation

This module is available for download in the WHMCS Marketplace
After downloading the module upload it to modules/servers/gsppanel in WHMCS and rename the PHP file to gsppanel.php

Login to GSP-Panel and go into Configuration > Settings > API > Setup an WebAPI Passphrase
Login to WHMCS and go to Setup > Servers, click “Add New Server”
Enter the following settings for “Edit Server”
- Name: GSP-Panel
- Hostname: URL to your installation. e.g. http://myinstall.gsp-panel.com/gsp/
- Maximum No. of Accounts: Any high number
Enter the following settings for “Server Details”
- Type: Select gsppanel
- Password: Enter the API password you previously setup
- Click “Save Changes”

This section is just an example to create a package compatible with GSP-Panel

Login to WHMCS and go to Setup > Products/Services, click “Create a New Group”
Name the group anything you want products under it to be associated with
Click “Create Group”
You should be back at the Products/Services page, click “Create a New Product”
Select the product type, select the group you just created and enter a name for the product and click “continue”
Enter these settings on the specified tabs
- Details
  - Uncheck “Require Domain”
- Pricing
  - Enter whatever pricing you want for the package
- Module Settings
  - Select Gsppanel as the module
  - Service Type: Select the type of service this will be
  - Game ID: This is only applicable to the “Game” service type. The GameID from GSP-Panel, you can find this in the url by going into Configuration > Game Templates > Edit Game and looking at the url, it should say “gid=<number>”, the number is the game's id
  - Slots: Not required if you'll be using a configurable option. This is the number of slots/players the server will have
  - Private: Not required if you'll be using a configurable option. This requires the game server to have a password
  - Priority: Not required if you'll be using a configurable option.
  - Location: Not required if you'll be using a configurable option. For the 'Game' Service Type this is the machines location.

Package custom fields
- These fields can be used to specify any options allowed in the games “Configurable Options” in GSP-Panel
Configurable Options
- These fields can be used the same as above
- Private field as a configurable option
  - Must be named “Private”
  - Valid options are “Yes” and “No”
- Priority field as a configurable option
  - Must be named “Priority”
  - Valid options are “Below Normal”, “Normal”, “Above Normal”, “High”, “Real Time”
- Slots field as a configurable option
  - Must be named “Slots”
  - Valid options are numbers
- Location field as a configurable option
  - Must be named “Location”
  - Valid options of location names setup for machines in GSP-Panel
- Dedicated IP as a configurable option
  - Must be named “Dedicated IP”
  - Valid options are “Yes” and “No”