Rozhraní API cloudových konzolí ESET
Abyste pochopili, jak změny ovlivní vaši integraci, je důležité rozlišovat mezi branou a kategoriemi rozhraní API, které obsluhuje.
ESET Connect (brána)
ESET Connect je cloudově hostovaná brána spravovaná výhradně společností ESET. Funguje jako vstupní bod mezi klientem a backendovými službami následujících cloudových služeb ESET:
Kategorie rozhraní ESET Connect API
Brána poskytuje přístup k specifickým sadám rozhraní API, které jsou uspořádány do kategorií.
Číslování verzí |
Každá kategorie rozhraní API má svůj vlastní nezávislý způsob číslování verzí. Je to verze, kterou uvádíte v odkazu ve svém kódu (např. /v1/groups). |
Impact |
Aktualizace kategorií rozhraní ESET Connect API mohou změnit volání API. |
Politika konce životního cyklu |
Politika zásadních změn
ESET může provést změny bez předchozího upozornění, pokud nejsou považovány za zásadní.
Společnost ESET vynaloží přiměřené úsilí, aby vás o zásadních změnách včas informovala a poskytla vám dostatek času na přizpůsobení se těmto změnám. |
Zásadní změna je změna rozhraní API, která může vyžadovat úpravy aplikace, aby se zabránilo narušení integrace, nebo si vyžádat změny pro zachování kompatibility.
Níže uvádíme několik příkladů změn, které považujeme za zásadní:
•změna formátu odpovědi,
•přejmenovaní pole,
•odstranění pole,
•změna typu údajů,
•změna kódu chyby,
•změna obchodní logiky.
K zásadním změnám může dojít i v důsledku úprav souvisejících s ověřováním, rozsahem oprávnění, limity pro počet volání, změnami v přenosu/URL a dalšími faktory.
Nezásadní změna je změna, které se můžete přizpůsobit podle vlastního uvážení a vlastním tempem bez narušení provozu.
Níže uvádíme několik příkladů změn, které nepovažujeme za zásadní:
•přidání nového pole,
•přidání nového volitelného parametru,
•přidaní nové hodnoty,
•zvýšení limitu požadavků,
•podpora více formátů atd.
Přechodné období
Během přechodného období, tedy v čase, kdy je předchozí verze kategorie API dostupná i po zavedení nové verze nebo funkční náhrady, zůstává předchozí verze k dispozici po stanovenou dobu poskytování částečné podpory. ESET vynaloží přiměřené úsilí na zajištění kompatibility a poskytne zákazníkům dostatečný čas na přizpůsobení se těmto změnám.
Období částečné podpory verze kategorií ESET Connect API začíná ve stanoveném termínu, obvykle v den zveřejnění oznámení pro koncové zákazníky. Verze kategorií ESET Connect API následně přejde do režimu částečné podpory a bude dostupná až do data ukončení životního cyklu. Po uplynutí období částečné podpory již verze kategorií ESET Connect API nebude dostupná.
Politika číslování verzí
Zásadní změny |
Každá verze obsahující zásadní změnu bude v dokumentaci jasně označena. |
Nezásadní změny |
Pokud vydání obsahuje pouze nezásadní změny, verze kategorie API zůstává stejná. Podrobnosti naleznete v Online nápovědě pro ESET Connect. |