Installation and Configuration of Contabo Cloud Automation for WHMCS

This tutorial will show you how to successfully install and configure Contabo Cloud Automation for WHMCS. We will guide and help you step by step through the whole process.

Downloading and Uploading to WHMCS

1. Access the client area at https://secure.whmcsmodule.net/ to download the module.
2. Extract the downloaded module files to your local environment.
3. Upload the entire 'modules' folder to the main directory of your WHMCS installation.

Obtaining API Key from Contabo

1. Sign in to your Contabo Customer Panel at https://my.contabo.com/account/login.
2. Navigate to the API section from the menu on the left.
3. Click on Send Link within the API page to initiate the process of setting or resetting your password.
4. Check your email inbox associated with your Contabo account. Follow the instructions to set your API password. Remember, your password should only include the characters '@' and '#', and no other special characters.
5. After successfully setting your API password, make note of the API Password, ClientId, Client Secret, and API username provided.

Activating Module in WHMCS

1. Navigate to Configuration > System Settings > Addon Modules in your WHMCS admin area.
2. Locate and select "Contabo Cloud":

• Click on "Activate" to enable the module.
• Then click on "Configure" to access module settings.
• Enter the license key provided during module download.
• Configure Access Control settings as per your requirements, ensuring Administrator access is set.
• Optionally, disable specific Custom OS options from appearing in the client area.
• Choose to automatically retrieve plans if they don't load within Product/Services > Module settings.
• Save your changes after configuring all necessary settings.

Adding API details

1. Go to Addons -> Contabo Cloud in your WHMCS admin panel.
2. Click on the "Add Project API Key" button.
3. Enter a descriptive Name for the API key for easy reference.
4. Fill in the API Password, ClientId, Client Secret, and API username that you obtained earlier from the "Obtaining API key from Contabo" section.

Now we have scuccessfully Installed and Configured the module.

Creating / Editing a WHMCS Product

1. Navigate to Configuration > System Settings > Products/Services.
2. Click on "Create Product Group".
3. Enter a name for the Product Group and configure other settings as needed, then click "Save Changes".
4. Now, create a new product.
5. Configure the following details on the next page:

• Product Type: Select "Other". Choosing "Other" avoids prompting customers for details like Hostname, Password, NS1 & NS2 prefixes during the order process. Selecting "Server/VPS" would require these details.
• Product Group: Choose the product group previously created.
• Product Name: Enter the name of your product.
• Module: Select "Contabo Cloud Automation".
• Create as Hidden: Keep this option off.
• Click "Save Changes" after setting up the required fields.

6. On the next page:
   • Verify the Product Type.
   • Select the appropriate "Welcome Email" (e.g., Droplets Welcome Email).
   • Navigate to the "Module Settings" tab.
7. In the "Module Settings" tab, configure the necessary details.
8. Ensure you click on "Create Configurable Options", which will streamline manual activities required for Configurable Options settings in the next step.
9. If Custom Plans selected then:

• Click on Save Changes and then go to Custom Fields Tab
• Fill the details like below which is for VPS Plan 1 (https://api.contabo.com/#tag/Instances/operation/createInstance) to allow your user to select the HDD type either SSD/ NVMe, do not change the Name before the | symbol and feel free to change “Storage Type” to your requirement
  • Name: productId|Storage Type
  • Type: Drop Down
  • Description: Select your disk type (SSD/NVMe)
  • Select Options: V45|SSD,V46|NVMe

Configurable Options

1. Navigate to System Settings -> Configurable Options (Note this step has to be followed for each and every product you create as Contabo charges different process for different product).
2. Locate and edit the configurable options relevant to your newly created product.
3. Configurable Option Volume - vmOSimage|Operating System
   • For this adjust the prices for Windows OS
4. Configurable Option – location|Server Location
   • As you know EU region price is free and Contabo charges prices for different region so edit the location|Server Location option and change the prices suitable for you
5. Configurable Option - license|License
   • This is for cPanel license etc, if you wanted to sell you can adjust the price or you can delete the section completely

Viewing Existing VPS/ Secrets/ Assigning VPS to customer

1. Click on the Server Icon () to view a list of all existing and created VPS instances.
2. Click on the Key Icon () to access the passwords for the VPS instances.
3. To view a specific VPS, click on the Server Icon.
4. Click on the Plus Icon () to import this VPS into your WHMCS.
5. After importing, navigate to Clients > View/Search Clients and find the customer you wish to assign this VPS to.
6. Edit the product associated with the user, then select the imported VPS from the Servers dropdown menu to assign it.

Note: If you encounter an "Unauthorized" error after providing your API details, first ensure that your API password does not contain any special characters other than @. If this doesn't resolve the issue, please open a support ticket with Contabo, as further assistance will need to come from their support team.