Všeobecné pravidlá

  • Rozhranie REST API je k dispozícii pod základnou adresou URL:

/public/external/api

  • Všetky požiadavky sa musia posielať prostredníctvom POST.
  • Rozhranie REST API podporuje len požiadavky cez protokol HTTPS.
  • Žiadosti musia obsahovať tieto hlavičky:
Upraviť

Názov hlavičky



Hodnota záhlavia



Popis



Typ obsahu



application/json



pevné



auth



123…xyz



Kľúč API z karty „Prístup k API“



podpis



Podpis v kóde Base64



Podpis užitočného zaťaženia vygenerovaného pomocou


súkromný kľúč z karty „Prístup k rozhraniu API“


  • Telo požiadavky musí byť objekt zakódovaný v tvare json, ktorý musí obsahovať nasledujúce hodnoty:
Upraviť

Pole



Príklad poľa Hodnota



Popis



api



v2/device/listdevices



Názov rozhrania API



čas



1529662725



Časová značka Unix (UTC) klientskeho počítača.


Maximálny povolený časový rozdiel


medzi klientom a serverom je 30


minút.


  • V prípade úspechu API vráti požadované údaje (pozri nižšie uvedené dotazy) a stavový kód HTTP 200.
  • Ak sa vyskytne chyba, stavový kód HTTP bude v závislosti od chyby 4xx až 5xx a objekt odpovede bude obsahovať pole s kľúčom „errors“, ktoré obsahuje zoznam ľudsky čitateľných chybových správ.
  • Ak pre zariadenie neexistujú žiadne zodpovedajúce údaje, vráti sa prázdne pole.
  • Ak identifikátor zariadenia neexistuje, jeho návratové údaje budú nulové.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.