Vultr Integration Setup

 January 4, 2021     0 Comments

With our Vultr integration, you can resell Vultr's VPS products in all 17 locations. This integration is available in Clientexec versions 6.3 and higher.


API Key & IP Address Whitelist


To start selling Vultr's VPS servers you will need to get your account API key and whitelist your website's IP address for API calls. You can do this by logging into your Vultr account and navigating to Account -> API.

Copy and save the API key for later and whitelist your server's IP address in the Access Control section.


Setting up a Vultr Server


Note: You do not need to provision a VPS server at Vultr to complete this step.

Once you have your API key, log into your Clientexec Admin Area and navigate to Settings -> Servers -> AddServer filling in the presented server form:

Server Name: For your internal reference. For example, 'VPS', or 'Vultr'.

Hostname: As a required field, you can input a placeholder hostname, for example, vps.your-website.com.

Plugin: Vultr

API Key: Paste in the API key you copied in the above step

VM Password Custom Field: The custom field name you will use when creating custom fields (see below)

VM Hostname Custom Field: The custom field name you will use when creating custom fields (see below)

VM Operating System Custom Field: The custom field name you will use when creating custom fields (see below)

VM Location Custom Field: The custom field name you will use when creating custom fields (see below).

You can leave the remaining options blank / at their default values.

Once done, click Save Changes.


Configuring Custom fields


Once you have set up a server, you will need to setup four custom fields. To do so, log into your Clientexec Admin Area and navigate to Settings -> Products -> Custom Fields -> Add Custom Field

Setup four custom fields, as described below:


VM Password: 

Field Name: The name you set for the VM Password Custom Field while setting up the server.

Field Type: Password

Include in Signup: No

Deselect All Product Groups

You can leave the other options blank / at their default values.


VM Hostname:

Field Name: The name you set for the VM Hostname Custom Field while setting up the server.

Is Required: Yes

Field Type: Text Field

Include in Signup: Yes

Include in portal lists: Yes (Optional, but recommended)

Include in Identifier: Yes (Optional, but recommended)

Deselect All Product Groups

You can leave the other options blank / at their default values.


VM Operating System: 

Field Name: The name you set for the VM Operating System Custom Field while setting up the server.

Field Type: Drop Down

Options: Leave this blank for now. The Vultr Helper (described below) will populate this.

Is Required: Yes

Include in Signup: Yes

Deselect All Product Groups

You can leave the other options blank / at their default values.


VM Location:

Field Name: The name you set for the VM Locations Custom Field while setting up the server.

Field Type: Drop Down

Options: Leave this blank for now. The Vultr Helper (described below) will populate this.

Is Required: Yes

Include in Signup: Yes

Deselect All Product Groups

You can leave the other options blank / at their default values.

With the custom fields set, you can enable the Vultr Helper snapin to populate the VM Location & Operating System options. To do this, log into your Clientexec Admin Area and navigate to Settings -> Plugins -> Snapins -> Vultr Helper and enable it.

Once enabled, navigate to Accounts -> Vultr Helper and select the Vultr server you created earlier. You should see two of the custom fields you created, Location and Operating System. Starting with Location, choose the locations you would like to offer to your clients from the Values field and click Save. Repeat this step for the Operating Systems.


Creating Packages


The final step is to create the actual packages. To do so, log into your Clientexec Admin Area and navigate to Settings -> Products -> Products.

Create a new product group for your VPS products, or modify an existing group selecting the four (4) custom fields you created in the previous steps.

Once you have created a group for your VPS products, create a product within that group. Once you have entered a product name and configured the other optional fields, click the Save Changes button to refresh the page.

Once the page refreshes, click the Advanced & Plugin Settings tab. In the field titled Associated Servers, select the Vultr server you created above and a new field should appear called 'Plan'. The plan represents the individual Vultr VPS packages that you can choose for this package. Once set, click Save Changes.

How helpful was this article to you?

Posting has been disabled.