Obecná pravidla

  • Rozhraní REST API je k dispozici pod základní adresou URL:

/public/external/api

  • Všechny požadavky musí být odeslány prostřednictvím POST.
  • Rozhraní REST API podporuje pouze požadavky přes protokol HTTPS.
  • Žádosti musí obsahovat následující záhlaví:
Upravit

Název záhlaví



Hodnota záhlaví



Popis



Typ obsahu



application/json



pevný



auth



123…xyz



Klíč API na kartě „Přístup k rozhraní API“



podpis



Podpis v kódování Base64



Podpis užitečného zatížení generovaného pomocí


soukromý klíč na kartě „Přístup k rozhraní API“


  • Tělo požadavku musí být kódovaný objekt json, který musí obsahovat následující hodnoty:
Upravit

Pole



Příklad pole Hodnota



Popis



api



v2/device/listdevices



Název rozhraní API



čas



1529662725



Časové razítko Unix (UTC) klientského počítače.


Maximální povolený časový rozdíl


mezi klientem a serverem je 30


minut.


  • V případě úspěchu vrátí rozhraní API požadovaná data (viz dotazy níže) a stavový kód HTTP 200.
  • Pokud dojde k chybě, bude stavový kód HTTP v závislosti na chybě mezi 4xx a 5xx a objekt odpovědi bude obsahovat pole s klíčem „errors“, které obsahuje seznam chybových zpráv, které lze přečíst.
  • Pokud pro zařízení neexistují žádná odpovídající data, vrátí se prázdné pole.
  • Pokud ID zařízení neexistuje, budou jeho návratová data nulová.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.