Інтерфейси програмування додатків для хмарних консолей ESET (API)
Щоб зрозуміти, як зміни впливають на вашу інтеграцію, важливо розрізняти категорії шлюзу та інтерфейсу програмування додатків (API), які він обслуговує.
ESET Connect (шлюз)
ESET Connect — це хмарний шлюз, яким повністю керує ESET. Він виступає точкою входу між клієнтом і бекенд-сервісами наступних хмарних сервісів ESET:
Категорії API ESET Connect
Шлюз надає доступ до певних наборів API, які організовані у категорії.
Версіонування |
Кожна категорія API має власний незалежний життєвий цикл версій. Це версія, яку ви вказуєте у своєму кодовому посиланні (наприклад, /v1/groups). |
Ударна стрічкова |
Оновлення категорій API ESET Connect можуть змінювати виклики API. |
Політика завершення підтримки |
Порушення політики змін
ESET може вносити зміни без попереднього повідомлення, якщо зміни вважаються непорушними.
|
ESET докладе розумних зусиль, щоб заздалегідь повідомити вас про актуальні зміни, маючи достатньо часу для адаптації до цих змін. |
Критичною зміною є зміна інтерфейсів програмування додатків (API), яка може вимагати змін у додатку, щоб уникнути порушень інтеграції або змін для збереження сумісності.
Нижче наведено кілька прикладів змін, які ми вважаємо критичними:
•змінено формат відповіді,
•поле перейменовано,
•поле видалено,
•Зміна типу даних,
•Зміна коду помилки,
•Зміна бізнес-логіки.
Порушення змін також можуть бути спричинені змінами, пов'язаними з автентифікацією, обсягом дозволів, обмеженнями швидкості, змінами транспорту/URL та іншими факторами.
Непорушна зміна — це зміна, до якої ви можете пристосуватися на власний розсуд і в темпі без перешкод.
Нижче наведено кілька прикладів змін, які ми вважаємо не порушуючими:
•Додано нове поле,
•додано новий опціональний параметр,
•нова додана цінність,
•підвищений ліміт тарифу,
•підтримка більшої кількості форматів тощо.
Перехідний період
Під час перехідного періоду, коли попередня версія категорії API залишається доступною після впровадження нової версії категорії API або функціональної заміни, попередня версія залишатиметься доступною протягом визначеного, обмеженого періоду підтримки. ESET докладе розумних зусиль, щоб забезпечити сумісність і надати клієнтам достатньо часу для адаптації до цих змін.
Обмежена підтримка версії ESET Connect API Categories починається з оголошеної дати, зазвичай у день публічного оголошення кінцевим користувачам. Версія ESET Connect API Categories перейде до обмеженої підтримки і буде доступна протягом усього періоду до кінця свого життєвого циклу. Після закінчення обмеженої підтримки версія ESET Connect API Categories більше не буде доступна.
Правила управління версіями
Різкі зміни |
Будь-яка версія, що містить критичні зміни, буде чітко позначена в документації. |
Безперервні зміни |
Якщо реліз містить лише непорушні зміни, версія категорії API залишається незмінною. Деталі можна знайти в довідковій документації ESET Connect Online. |