Integrating VPS Setup and Operation into 3^rd Party Sites and Software

Version 0.9.1 ©2014 InterServer

To use the API you will need to first have an account with us.  You can sign up for an account at http://my.interserver.net/

• You will need the login name (email address) you used to sign up with InterServer and your password.
• The SOAP server is accessible at https://my.interserver.net/api.php
• The WSDL is available at https://my.interserver.net/api.php?wsdl

• We use a session based authentication system.   You will need to authenticate yourself with our system to get a Session ID.   Once you have a Session ID, you just pass that to prove your identity.  

• To get a Session ID, you need to make a SOAP call to api_login(login, password)  using the information you use to login to https://my.interserver.net

• Sending an api_login(login, password) call will attempt to authenticate your account and if successful will return a Session ID valid for at least several hours.    Subsequent commands and calls to the API will need this Session ID, so keep it handy.

<?php
	$client = new SoapClient("https://my.interserver.net/api.php?wsdl");
	$session_id = $client->api_login('[email protected]', 'password');
	if (!strlen($session_id) > 0)
		die("Failure!\nNo Session Returned - Bad Login Info\n");
	echo "Success!\n Got Session ID: {$session_id}\n”;
	// Rest of code logic would go here
?>

 #!perl -w
  use SOAP::Lite;
  print SOAP::Lite
	-> uri('urn:myapi')
	-> proxy('https://my.interserver.net/api.php?wsdl')
	-> api_login('[email protected]', 'password')
	-> result;

from pysimplesoap.client import SoapClient
client = SoapClient(wsdl="https://my.interserver.net/api.php?WSDL",trace=False)
response = client.api_login('[email protected]', 'password')
print response

We have several types of Servers available for use with VPS Hosting. You can get a list of the types available and there cost per slice/unit by making a call to the get_vps_slice_types  function.

Each Type of Virtualization has its own set of installable OS templates/images.   To get a list of them use the get_vps_templates function.

Still need to document these:

• api_make_payment
• api_get_paypal_url
• api_vps_get_service
• api_vps_get_services
• api_vps_cancel_service
• api_vps_get_client_invoices
• api_vps_queue_stop
• api_vps_queue_start
• api_vps_queue_restart
• api_vps_get_client_unpaid_invoices
• api_vps_screenshot
• api_vps_get_server_name
• get_hostname

Use this function to get a list of the various platforms available for ordering. The platform field is also needed to pass to the buy_vps functions.

No Input / Parameters to pass

Use this function to get a list of the Locations available for ordering. The id field is also needed to pass to the buy_vps functions.

No Input / Parameters to pass

This function creates a session in our system which you will need to pass to most functions for authentication.

*This is temporary and will be changed to an API specific key at some point

String output, the Session ID if successfull, otherwise a blank string

No Input / Parameters to pass

Outputs an associative array.

• (as of 12/14/2014)

Checks if the parameters for your order pass validation and let you know if there are any errors. It will also give you information on the pricing breakdown.

<?php
	$client = new SoapClient("https://my.interserver.net/api.php?wsdl");
	$sid = $client->api_login('[email protected]', 'password');
	if (!strlen($sid) > 0)
		die("Failure!\nNo Session Returned - Bad Login Info\n");
	$os='ubuntu-14.04-x86_64.tar.gz';	// from $templates[]['file']
	$slices=1;							// 1-16
	$platform='kvm';					// from $platforms[]['platform'] ?
	$controlpanel='none';				// none, cpanel, or da
	$period=1;							// 1-anything really
	$location=1;						// from $locations[]['id']
	$version='ubuntu';					// from $templates[]['os']
	$hostname='vpsapi.test.com';
	$coupon='';
	$rootpass='apitest';
	$response = $client->api_api_validate_buy_vps($sid, $os, $slices, $platform, $controlpanel, $period, $location, $version, $hostname, $coupon, $rootpass);
    if ($response['status'] != 'ok')
		die("Errors In Order\n{$errors}\n");
	echo "The order parameters are valid\n";
    echo "This order would cost {$response['service_cost']}\n";
	// Rest of code logic would go here
?>

Places a VPS order in our system. These are the same parameters as api_validate_buy_vps.

<?php
	$client = new SoapClient("https://my.interserver.net/api.php?wsdl");
	$sid = $client->api_login('[email protected]', 'password');
	if (!strlen($sid) > 0)
		die("Failure!\nNo Session Returned - Bad Login Info\n");
	$os='ubuntu-14.04-x86_64.tar.gz';	// from $templates[]['file']
	$slices=1;							// 1-16
	$platform='kvm';					// from $platforms[]['platform'] ?
	$controlpanel='none';				// none, cpanel, or da
	$period=1;							// 1-anything really
	$location=1;						// from $locations[]['id']
	$version='ubuntu';					// from $templates[]['os']
	$hostname='vpsapi.test.com';
	$coupon='';
	$rootpass='apitest';
	$response = $client->api_api_buy_vps($sid, $os, $slices, $platform, $controlpanel, $period, $location, $version, $hostname, $coupon, $rootpass);
    if ($response['status'] != 'ok')
		die("Errors In Order\n{$errors}\n");
    echo "Order Placed\n";
    echo "VPS ID: {$response['status_text']}\n";
    echo "Cost: {$response['cost']\n";
    echo "Invoices: {$response['invoices']}\n";
	// Rest of code logic would go here
?>

No Input / Parameters to pass

Outputs an associative array.

If you have any questions or ideas on how we can improve our services, please let us know at [email protected],