Knowledge base
How can I communicate with the Oktawave API?
Posted by on 04.11.2013 11:29
Our API currently supports two methods of data exchange. The first one is based on XML/SOAP and this is the original version of the communication interface, which is available on our platform. At the same time we introduced support for the so-called JSON light. Both interfaces (endpoints) are fully compatible with each of the names of the methods that are widely described here: http://docs.oktawave.com/api/v1.0/.

 

The standard addresses for API communication:

  1. JSON
    https://api.oktawave.com/ClientsService.svc/json
    https://api.oktawave.com/CommonService.svc/json
     
  2. XML/SOAP
    https://api.oktawave.com/ClientsService.svc
    https://api.oktawave.com/CommonService.svc

 

Below is an example showing how to retrieve a list of all the OCI operating in the account using JSON.

 

1. Authorization and getting customer ID

We call the method https://api.oktawave.com/CommonService.svc/json/LogonUser with parameters:

{ "ipAddress": "nasz_IP", 
"password": "password",
"user": "login"
 } 

In response, we get a lot of information about our account, this one is much needed in the follow-up - the ClientID = XXX, signifying the customer ID.

 

2. Getting the list of OCI

We call the method https://api.oktawave.com/ClientsService.svc/json/GetVirtualMachinesSimple with parameters:

{
  "clientId": n
 }

where n is ClientID got in step number 1. In response we get for example:

{
    "GetVirtualMachinesSimpleResult": [
        {
            "StatusDictId": 86,
            "VirtualMachineId": 111,
            "VirtualMachineName": "pierwsza"
        },
        {
            "StatusDictId": 87,
            "VirtualMachineId": 222,
            "VirtualMachineName": "druga"
        },
        {
            "StatusDictId": 87,
            "VirtualMachineId": 333,
            "VirtualMachineName": "trzecia"
        }

In the next steps with VirtualMachineId we can directly manage every OCI.

(0 vote(s))
This article was helpful
This article was not helpful

Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments:
CAPTCHA Verification 
 
Please enter the text you see in the image into the textbox below. This is required to prevent automated registrations and form submissions.