Vispārīgie noteikumi

  • REST API ir pieejams zem bāzes URL:

/public/external/api

  • Visi pieprasījumi jānosūta, izmantojot POST.
  • REST API atbalsta tikai HTTPS pieprasījumus.
  • Pieprasījumos jāietver šādas galvenes:
Rediģēt

Virsraksta nosaukums



Virsraksta vērtība



Apraksts



Satura veids



application/json



fiksēts



auth



123…xyz



API atslēga no cilnes “API piekļuve”



paraksts



Base64 kodēts paraksts



Lietderīgās slodzes paraksts, kas ģenerēts ar


privātā atslēga no cilnes “API piekļuve”


  • Pieprasījuma ķermenim jābūt json kodētam objektam, kurā jāietver šādas vērtības:
Rediģēt

Laukums



Lauka piemērs Vērtība



Apraksts



api



v2/device/listdevices



API nosaukums



laiks



1529662725



Klienta datora Unix laika zīmogs (UTC).


Maksimāli pieļaujamā laika starpība


starp klientu un serveri ir 30


minūtes.


  • Veiksmes gadījumā API atgriež pieprasītos datus (sk. tālāk sadaļā Pieprasījumi) un HTTP statusa kodu 200.
  • Ja rodas kļūda, HTTP statusa kods atkarībā no kļūdas būs no 4xx līdz 5xx, un atbildes objekts saturēs masīvu ar atslēgu “errors”, kurā ir cilvēkam saprotamu kļūdu ziņojumu saraksts.
  • Ja ierīcei nav atbilstošu datu, tiek atgriezts tukšs masīvs.
  • Ja ierīce Id nepastāv, tās atgrieztie dati būs nulle.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.