API Oktawave

Oktawave API is an interface layer that allows all customers to manage their own services using external tools. It also allows developers of partner applications to connect with the Oktawave system and to create their own access programme.

From the application that uses the Oktawave API you can perform all the operations that are possible in the Oktawave system within your customer account (end user) and Partner account (administrative unit).

All services and data are kept in Oktawave data centres, however, both the Customer and the Partner have the opportunity to manage them remotely. Partner's billing of his customers (including the determination of tariffs) is entirely in his discretion.

Full documentation can be found here: http://docs.oktawave.com/api/v1.0/.

You can also take advantage of our full tutorial, that will show you how to start using the Oktawave API.


What can be done using the API Oktawave?

As mentioned above, using the API Oktawave makes it possible to implement all the operations that can be performed directly by the customer and by partner on the set of his customers. This applies to the following two levels of organization.

Customer level

  • creating OCI instances and their management, including configuration, creating snapshots, connecting to the remote console, scheduling operations (scheduler), autoscaling.
  • creating shared virtual disks and their management (OVS - Oktawave Volume Storage)
  • creating virtual private networks and their management (OPN – Oktawave Private Network),
  • creating databases MySQL and PostgreSQL in a SaaS scenario and their management (ORDB – Oktawave Relational Databases)
  • creating containers and load balancing configuration,
  • creating standalone applications (Applications)
  • configuration and access to OCS – Oktawave Cloud Storage.

Partner level

  • customer management (create, configure, lock accounts, log in to customer account)
  • service requests from clients,
  • internal exchange platform of announcements, files, communications with customers, knowledge base.

What is the philosophy of communication with Oktawave?

API Oktawave method calls occur on the external application or script. API Oktawave does not initiate any communication.

Shared methods are multiple - they can pursue both download of data (e.g. "take the names of all the instances belonging to John Doe"), and perform operations (such as "turn an instance Y").

Regardless of the methods of authorization and authentication on a technical level API allow you to operate only on the objects to which the user has permission (in the context of which API method is called). For example, the user can not turn on the instance belonging to a different customer than himself (one customer can have multiple users). He will also not be able to submit a service order, unless the customer, to whom it belongs, does not have the appropriate permissions.

External application or script based on data collected from the API Oktawave displays its interface (e.g. web application, mobile application, CLI), and allows operations on the returned objects. There is no need to permanently store any data on the services on the side of an application or a script – they all there on the Oktawave.

Of course, the application used by the Customer or a Partner, can cache the data and also store additional information needed for example for billing their clients.


Architecture Overview

API Oktawave is made available as Web services, according to universal standards based on SOAP. Services are available over HTTPS, and access is possible after the authentication of the connection on the basis of HTTP basic authorization.

The account under which the connection is performed should reflect the context of the user currently logged on to the external application. Only then it will be possible to identify the correct user-side API and to apply appropriate mechanisms for authorizing.

It is important not to pursue methods of managing individual customer service with your Partner account. This scenario brings the risk of a proper management of permissions to Partner’s application.


Security and Authentication

Confidentiality of data exchanged between the external systems with the corresponding API Oktawave is protected by transport layer based on SSL. Communication and authorization are based on any valid account created in Oktawave.

It is not necessary in any case to create additional access to API, and it doesn’t require any additional account of other privileges.

Therefore, the connection to be established should be done in the context of the user logged on to an external application, not the Partner account. In this context all further operations are performed in the Oktawave.

Authentication mechanism on the side of API uses the AD protocol based on LDAP (MS Active Directory) and Kerberos. This means that each order accepted and implemented by the API is performed only in the context of the user who called the method. There is never a master account, with wider privileges acting on behalf of the user.

API Oktawave does not maintain the user session; it is completely on the external application or script. API authenticates only the single method calls based on the context passed to the transport layer. API Oktawave can be used as an external authorization mechanism for any application.


Check the example

Below is an example of a simple sequence of API method calls leading up to the user authentication (e.g. writing data in log in formo f Partner’s application), shuting down all its instances, then creating a new one.

Instance is created based on C #, classes OktawaveXXXClient which are are occurring are the proxy classes generated by wsdl.exe tool (included in Microsoft Visual Studio) for each web services included in the API Oktawave.


OktawaveCommonClient commonClient = new OktawaveCommonClient();
User user = commonClient.LogonUser(”user_test”, “secretPassword”);

if(user != null)
{
    OktawaveClientsClient clientsClient = new OktawaveClientsClient();

    clientsClient.Credentials.UserName.UserName = “user_test”;
    clientsClient.Credentials.UserName.Password = “secretPassword”;

    VirtualMachineSearchParams searchParams = new VirtualMachineSearchParams();
    searchParams.ClientId = user.Client.ClientId; 
    SearchResultsCollection<VirtualMachineView> machines = clientsClient.GetVirtualMachines(searchParams);

    foreach (VirtualMachineView vm in machines)
    {
        clientsClient.TurnoffVirtualMachine( vm.VirtualMachineId, user.Client.ClientId); 
        clientsClient.CreateVirtualMachineWithSpecificDiskSize( selectedTemplateId, 20, null, “new_virtual_machine”, selectedClass, null, selectedConnectionType, selectedPaymentMethod, user.Client.ClientId, null, Consts.DAL.TemplateType.Machine, null, null);
    }
}

WSDL files

Here are also several WSDL files describing the protocols and formats used by the API Oktawave to communicate.

For Customers:

For Partners: