Knowledge base
W jaki sposób mogę komunikować się z API Oktawave?
Posted by on 04.11.2013 11:22
Nasze API obecnie obsługuje dwa sposoby wymiany danych. Pierwszy z nich bazuje na XML/SOAP i jest to pierwotna wersja interfejsu komunikacyjnego, który został udostępniony na naszej platformie. Równolegle wprowadziliśmy wsparcie dla tzw. lekkiego JSON. Oba interfejsy (tzw. endpointy) są w pełni ze sobą zgodne w zakresie nazewnictwa metod, które szerzej są opisane tutaj: http://docs.oktawave.com/api/v1.0/.

Standardowe adresy komunikacyjne z API to:

  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

 

Poniżej zamieszczamy przykład pokazujący, jak pobrać listę wszystkich OCI działających w obszarze konta za pomocą JSON.

 

1. Autoryzacja i pobranie ID klienta

Wywołujemy  metodę  https://api.oktawave.com/CommonService.svc/json/LogonUser z parametrami:

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

W odpowiedzi otrzymamy bardzo dużo informacji o naszym koncie, w tym jedną bardzo potrzebną w dalszych działaniach, czyli ClientID=XXX, oznaczający identyfikator klienta.

 

2. Pobranie list OCI

Wywołujemy metodę https://api.oktawave.com/ClientsService.svc/json/GetVirtualMachinesSimple z parametrami:

{
  "clientId": n
 }

gdzie pod n należy podstawić ClientID pobrany w punkcie nr 1. W odpowiedzi otrzymujemy listę, np.

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

W kolejnych krokach za pomocą VirtualMachineId możemy już bezpośrednio zarządzać każdym OCI.

(7 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.