Splošna pravila

  • API REST je na voljo pod osnovnim naslovom URL:

/public/external/api

  • Vsi zahtevki morajo biti poslani prek protokola POST.
  • API REST podpira samo zahteve prek protokola HTTPS.
  • Zahteve morajo vsebovati naslednje glave:
Uredi

Ime glave



Vrednost glave



Opis



Vrsta vsebine



application/json



popravljeno



avtentikacija



123…xyz



Ključ API z zavihka “Dostop do API”.



podpis



podpis v kodi Base64



Podpis koristnega bremena, ustvarjenega z


zasebni ključ z zavihka “Dostop do API”.


  • Telo zahteve mora biti kodiran objekt json, ki mora vsebovati naslednje vrednosti:
Uredi

Polje



Polje Primer Vrednost



Opis



api



v2/device/listdevices



Ime API



čas



1529662725



Časovni žig Unix (UTC) odjemalskega računalnika.


Največja dovoljena časovna razlika


med odjemalcem in strežnikom je 30


minut.


  • Ob uspehu API vrne zahtevane podatke (glejte poizvedbe spodaj) in kodo stanja HTTP 200.
  • Če pride do napake, bo koda stanja HTTP med 4xx in 5xx, odvisno od napake, objekt odgovora pa bo vseboval polje s ključem “errors”, ki vsebuje seznam človeku razumljivih sporočil o napakah.
  • Če za napravo ni ustreznih podatkov, se vrne prazno polje.
  • Če Id naprave ne obstaja, bodo vrnjeni podatki nič.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.