Rozhrania API cloudových konzol ESET
Aby ste pochopili, ako zmeny ovplyvňujú vašu integráciu, je dôležité rozlišovať medzi bránou a kategóriami rozhraní API, ktoré obsluhuje.
ESET Connect (brána)
ESET Connect je cloudová brána, ktorú plne spravuje ESET. Slúži ako vstupný bod medzi klientom a backendom nasledujúcich cloudových služieb ESET:
Kategórie rozhraní ESET Connect API
Brána poskytuje prístup k špecifickým súborom rozhraní API, ktoré sú usporiadané do kategórií.
Číslovanie verzií |
Každá kategória rozhrania API má svoj vlastný nezávislý cyklus číslovania verzií. Je to verzia, ktorú uvádzate v odkaze vo svojom kóde (napr. /v1/groups). |
Vplyv |
Aktualizácie kategórií rozhraní ESET Connect API môžu zmeniť volania API. |
Politika životného cyklu produktov |
Politika zásadných zmien
ESET môže vykonať zmeny bez predchádzajúceho upozornenia, ak sa nepovažujú za zásadné.
Spoločnosť ESET vynaloží primerané úsilie, aby vás o zásadných zmenách vopred informovala a poskytla vám dostatok času na prispôsobenie sa týmto zmenám. |
Zásadná zmena je zmena rozhraní API, ktorá môže vyžadovať úpravy aplikácie, aby sa predišlo narušeniu integrácie, alebo úpravy na zachovanie kompatibility.
Nižšie uvádzame niekoľko príkladov zmien, ktoré považujeme za zásadné:
•zmenený formát odpovede,
•premenované pole,
•odstránené pole,
•zmena typu údajov,
•zmena kódu chyby,
•zmena obchodnej logiky.
K zásadným zmenám môže dôjsť aj v dôsledku úprav súvisiacich s overovaním, rozsahom povolení, limitmi požiadaviek, zmenami prenosu/URL adries a ďalšími faktormi.
Iná ako zásadná zmena je zmena, ktorej sa môžete prispôsobiť podľa vlastného uváženia a vlastným tempom bez narušenia prevádzky.
Nižšie uvádzame niekoľko príkladov zmien, ktoré nepovažujeme za zásadné:
•pridané nové pole,
•pridaný nový voliteľný parameter,
•pridaná nová hodnota,
•zvýšený limit požiadaviek,
•podpora viacerých formátov atď.
Prechodné obdobie
Počas prechodného obdobia, teda v čase, keď je predchádzajúca verzia kategórie API dostupná aj po zavedení novej verzie alebo funkčnej náhrady, zostáva predchádzajúca verzia k dispozícii počas stanoveného obdobia poskytovania obmedzenej podpory. ESET vynaloží primerané úsilie na zabezpečenie kompatibility a poskytne zákazníkom dostatočný čas na prispôsobenie sa týmto zmenám.
Obdobie obmedzenej podpory verzie kategórií ESET Connect API začína plynúť v stanovenom termíne, zvyčajne v deň zverejnenia oznámenia pre koncových zákazníkov. Verzia kategórií ESET Connect API následne prejde do režimu obmedzenej podpory a bude dostupná až do dátumu ukončenia životného cyklu. Po uplynutí obdobia obmedzenej podpory už verzia kategórií ESET Connect API nebude dostupná.
Politika číslovania verzií
Zásadné zmeny |
Každá verzia obsahujúca zásadnú zmenu bude v dokumentácii jasne označená. |
Iné ako zásadné zmeny |
Ak vydanie zahŕňa iba iné ako zásadné zmeny, verzia kategórie API zostáva rovnaká. Podrobnosti nájdete v dokumentácii Online pomocníka pre ESET Connect. |