Jak działa API

Typy wywołań API

Typy wywołań GET, POST i DELETE API są dostępne w ESET PROTECT On-Prem API.

•Wywołania GET zawierają wszelkie parametry wejściowe (nie mają własnej treści) i przesyłają dane bezpośrednio do URL. Wywołanie żądania nie może być modyfikowane; tylko wykonane.

•Wywołania POST wymagają treści żądania — parametry są dokumentowane dla każdego wywołania POST.

•W żądaniach API zawierających paginację (page_size) rozmiar strony domyślnej wynosi 100, a maksymalny rozmiar to 10000.

Każde wywołanie składa się z następujących elementów:

•Typ wywołania

•URL żądania

•Nagłówek żądania (może zawierać token uwierzytelniający)

•Treść żądania (zawiera dane, zwłaszcza przy wywołaniach POST)

Struktura odpowiedzi serwera

Każde wywołanie API otrzymuje odpowiedź od serwera REST. Odpowiedź składa się z kodu odpowiedzi serwera oraz odpowiedzi sformatowanej jako dane w JSON.

Odpowiedź składa się z następujących elementów:

•Kod serwera

•Ciało odpowiedzi

•Nagłówki odpowiedzi

Przykłady wywołań API

GET

Wyświetl politykę (Policy_UUID pochodzi z konsoli internetowej):

POST

Przenieś urządzenie do konkretnej grupy statycznej (identyfikator komputera jest zawarty w URL):