Принцип роботи API

Типи викликів API

В ESET PROTECT On-Prem API доступні такі типи викликів API, як GET, POST і DELETE.

•Виклики GET не мають вхідних параметрів і, відповідно, не мають тіла запиту. Вони надсилають дані безпосередньо в URL-адресу. Виклик запиту можна лише виконати, але не змінити.

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

•У запитах API із поділом на сторінки (page_size) розмір сторінки за замовчуванням становить 100, а максимальний розмір — 10000.

Нижче перелічено компоненти викликів.

•Тип виклику

•URL-адреса запиту

•Заголовок запиту (може складатися з маркера автентифікації)

•Тіло запиту (містить дані, особливо у викликах POST)

Структура відповіді сервера

Для кожного виклику API надходить відповідь із сервера REST. Вона складається з коду й даних у форматі JSON.

Нижче перелічено компоненти відповіді.

•Код сервера

•Тіло відповіді

•Заголовок відповіді:

Приклади викликів API

GET

Відобразити політику (Policy_UUID береться з вебконсолі).

POST

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