Как работает API

Типы вызовов API

Типы вызовов API GET, POST и DELETE доступны в API ESET PROTECT On-Prem.

•Вызовы GET не содержат вводимых параметров (не имеют тела) и отправляют данные непосредственно в URL-адресе. Вызов запроса нельзя изменить. Его можно только выполнить.

•Для вызовов POST требуется тело запроса — параметры описаны для каждого вызова POST.

•В запросах API, включающих разбивку на страницы (page_size), размер страницы по умолчанию равен 100, а максимальный размер — 10000.

Каждый вызов включает в себя:

•тип вызова;

•URL-адрес запроса;

•заголовок запроса (может состоять из токена аутентификации);

•тело запроса (содержит данные, особенно при вызовах POST).

Структура ответа сервера

Каждый вызов API получает ответ от сервера REST. Ответ состоит из кода ответа сервера и ответа в виде данных в формате JSON.

Ответ включает в себя:

•код сервера;

•тело ответа;

•заголовки ответа.

Примеры вызовов API

GET

Показать политику (Policy_UUID берется из веб-консоли):

POST

Переместить устройство в определенную статическую группу (идентификатор компьютера включен в URL-адрес):