Zasady ogólne

  • Interfejs API REST jest dostępny poniżej podstawowego adresu URL:

/public/external/api

  • Wszystkie żądania muszą być wysyłane metodą POST.
  • Interfejs API REST obsługuje tylko żądania za pośrednictwem protokołu HTTPS.
  • Żądania muszą zawierać następujące nagłówki:
Edytuj

Nazwa nagłówka



Wartość nagłówka



Opis



Typ zawartości



application/json



stały



auth



123…xyz



Klucz API z zakładki „Dostęp API”



podpis



Podpis zakodowany w Base64



Podpis ładunku wygenerowanego za pomocą


klucz prywatny z zakładki „Dostęp API”


  • Treść żądania musi być zakodowanym obiektem json, który musi zawierać następujące wartości:
Edytuj

Pole



Pole Przykład Wartość



Opis



api



v2/device/listdevices



Nazwa interfejsu API



czas



1529662725



Unix Timestamp (UTC) komputera klienckiego.


Maksymalna dozwolona różnica czasu


między klientem a serwerem wynosi 30


minut.


  • W przypadku powodzenia API zwraca żądane dane (patrz Zapytania poniżej) i kod statusu HTTP 200.
  • Jeśli wystąpi błąd, kod statusu HTTP będzie wynosił od 4xx do 5xx w zależności od błędu, a obiekt odpowiedzi będzie zawierał tablicę z kluczem „errors”, która zawiera listę komunikatów o błędach czytelnych dla człowieka.
  • Jeśli nie ma pasujących danych dla urządzenia, zwrócona zostanie pusta tablica.
  • Jeśli identyfikator urządzenia nie istnieje, zwrócone dane będą miały wartość null.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.