Bendrosios taisyklės

  • REST API galima rasti po baziniu URL adresu:

/public/external/api

  • Visos užklausos turi būti siunčiamos POST būdu.
  • REST API palaiko tik HTTPS užklausas.
  • Užklausose turi būti šios antraštės:
Redaguoti

Antraštės pavadinimas



Antraštės vertė



Aprašymas



Turinio tipas



application/json



fiksuotas



auth



123…xyz



API raktas iš skirtuko „API prieiga”



parašas



Base64 koduotas parašas



Naudingosios apkrovos, sukurtos naudojant


privatus raktas iš skirtuko „API prieiga”


  • Užklausos kūnas turi būti json užkoduotas objektas, kuriame turi būti šios reikšmės:
Redaguoti

Laukas



Lauko pavyzdys Reikšmė



Aprašymas



api



v2/device/listdevices



API pavadinimas



laikas



1529662725



kliento kompiuterio „Unix” laiko žyma (UTC).


Didžiausias leistinas laiko skirtumas


tarp kliento ir serverio yra 30


minučių.


  • Sėkmės atveju API grąžina prašomus duomenis (žr. Užklausas toliau) ir HTTP būsenos kodą 200.
  • Jei įvyksta klaida, HTTP būsenos kodas, priklausomai nuo klaidos, bus nuo 4xx iki 5xx, o atsakymo objekte bus masyvas su raktu „errors”, kuriame pateikiamas žmogui suprantamų klaidų pranešimų sąrašas.
  • Jei įrenginio duomenų nėra, grąžinama tuščia masyvų lentelė.
  • Jei įrenginio Id neegzistuoja, jo grąžinami duomenys bus nuliniai.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.