Interfejsy programistyczne ESET Cloud Console (API)
Aby zrozumieć, jak zmiany wpływają na integrację, ważne jest, aby rozróżnić gateway od kategorii interfejsu programowania aplikacji (API), które ona obsługuje.
ESET Connect (gateway)
ESET Connect to brama hostowana w chmurze, zarządzana w całości przez ESET. Działa jako punkt wejścia między klientem a usługami zaplecza następujących usług chmurowych ESET:
Kategorie API ESET Connect
Gateway zapewnia dostęp do konkretnych zestawów API, które są zorganizowane w kategorie.
Wersjonowanie |
Każda kategoria API ma własny, niezależny cykl życia wersjonowania. To jest wersja, którą podajesz w swoim linku kodowym (np. /v1/groups). |
Uderzeniowe |
Aktualizacje kategorii API ESET Connect mogą zmieniać wywołania API. |
Polityka dotycząca końca okresu użytkowania |
Zmiany przełomowe - polityka
ESET może wprowadzać zmiany bez wcześniejszego powiadomienia, jeśli zmiana jest uznana za nieprzełamującą.
|
ESET podejmie rozsądne działania, aby z wyprzedzeniem powiadomić Cię o zmianach z odpowiednim wyprzedzeniem, aby się do nich dostosować. |
Zmiana przełamowająca to zmiana interfejsów programowania aplikacji (API), która może wymagać modyfikacji aplikacji, aby uniknąć zakłóceń w integracji lub konieczna w celu utrzymania kompatybilności.
Oto kilka przykładów zmian, które uważamy za zmiany łamujące:
•zmieniony format odpowiedzi,
•pole zmieniło nazwę,
•pole usunięte,
•zmiana typu danych,
•zmiana kodu błędu,
•zmiana logiki biznesowej.
Zmiany przełomowe mogą być również spowodowane zmianami dotyczącymi uwierzytelniania, zakresu uprawnień, limitów prędkości, zmian transportu/URL oraz innych czynników.
Zmiana nieprzerywająca to taka, do której możesz dostosować się według własnego uznania i tempa, bez zakłóceń.
Poniżej przedstawiamy kilka przykładów zmian, które uważamy za nienaruszające zmiany:
•dodano nowe pole,
•dodano nowy opcjonalny parametr,
•nowa wartość dodana,
•zwiększone limity stawek,
•wsparcie dla większej liczby formatów itd.
Okres przejściowy
W okresie przejściowym, gdy w okresie dostępnym pozostaje poprzednia wersja kategorii API po wprowadzeniu nowej wersji kategorii API lub funkcjonalnej zamiennicy, poprzednia wersja będzie nadal dostępna przez określony okres ograniczonego wsparcia. ESET podejmie rozsądne działania, aby zapewnić kompatybilność i zapewnić klientom wystarczająco dużo czasu na przystosowanie się do tych zmian.
Ograniczona obsługa dla wersji ESET Connect API Categories zaczyna się od ogłoszonego dnia, zazwyczaj w dniu publicznego ogłoszenia dla klientów końcowych. Wersja ESET Connect API Categories przejdzie do Limited Support i będzie dostępna przez cały okres aż do daty zakończenia jej życia. Po upływie ograniczonego wsparcia wersja ESET Connect API Categories nie będzie już dostępna.
Reguły dotyczące wersjonowania
Zmiany przełomowe |
Każda wersja zawierająca zmianę łamiącą będzie wyraźnie oznaczona w dokumentacji. |
Zmiany nieprzerwane |
Jeśli wydanie zawiera tylko zmiany nieprzełamujące się, wersja kategorii API pozostaje taka sama. Szczegóły można znaleźć w dokumentacji pomocy ESET Connect Online. |