Vállalati termékek irányelvei – Tartalomjegyzék

ESET felhőkonzolok alkalmazásprogramozási interfészei (API)

Annak megértéséhez, hogy a változások hogyan befolyásolják az integrációt, fontos különbséget tenni az átjáró és az általa kiszolgált alkalmazásprogramozási interfész (API) kategóriái között.

ESET Connect (átjáró)

Az ESET Connect egy felhőalapú átjáró, amelyet teljes egészében az ESET kezel. Belépési pontként szolgál az ügyfél és az alábbi ESET felhőszolgáltatásainak háttérszolgáltatásai között:

ESET PROTECT (Cloud)

ESET Inspect

ESET Cloud Office Security

ESET Connect API kategóriák

Az átjáró hozzáférést biztosít bizonyos API-készletekhez, amelyek kategóriákba vannak rendezve.

Programverziók számozása

Minden API-kategóriának megvan a saját független verziókészítési életciklusa. Ezt a verziót adja meg a kódhivatkozásban (pl. /v1/groups).

Mechanikus

Az ESET Connect API-kategóriák frissítései módosíthatják az API-hívásokat.

Életciklus végéről szóló szabályzata

Támogatási irányelvek E kategória

Megtörő változási politika

Az ESET előzetes értesítés nélkül módosíthatja, ha a módosítást nem törődnek tekintik.


Értesítés

Az ESET ésszerű erőfeszítéseket tesz annak érdekében, hogy előzetesen értesítse Önt a változásokról, elegendő idővel ahhoz, hogy alkalmazkodjon ezekhez a változásokhoz.

A törésváltozás az alkalmazásprogramozási interfészek (API-k) módosítása, amely módosításokat igényelhet egy alkalmazáson az integráció megzavarásának elkerülése érdekében, vagy módosításokat igényelhet a kompatibilitás fenntartása érdekében.

Az alábbiakban bemutatunk néhány példát azokra a változásokra, amelyeket törő változásoknak tartunk:

megváltozott válasz formátum,

mező átnevezve,

mező eltávolítva,

adattípus változása,

hibakód változás,

változás az üzleti logikában.

A törő változásokat a hitelesítéssel, az engedélyezési hatókörrel, a sebességkorlátozásokkal, a szállítás/URL-változásokkal és egyéb tényezőkkel kapcsolatos változások is okozhatják.

A nem törő változás olyan változás, amelyhez saját belátása szerint és ütemében megszakítás nélkül alkalmazkodhat.

Az alábbiakban bemutatunk néhány példát azokra a változásokra, amelyeket úgy gondolunk, hogy nem törő változások:

új mező hozzáadva,

új opcionális paraméter hozzáadva,

új hozzáadott érték,

megnövekedett kamatláb,

több formátum támogatása stb.

Átmeneti időszak

Az átmeneti időszak alatt, mivel az az időkeret alatt az API-kategória korábbi verziója az új API-kategória verziójának bevezetése vagy a funkcionális helyettesítés bevezetése után elérhető marad, az előző verzió egy meghatározott, Korlátozott támogatási időszakra továbbra is elérhető lesz. Az ESET ésszerű erőfeszítéseket tesz a kompatibilitás biztosítása érdekében, és elegendő időt biztosít az ügyfeleknek ahhoz, hogy alkalmazkodjanak ezekhez a változásokhoz.

Az ESET Connect API-kategóriák verziójának limitált támogatása a bejelentett időpontban kezdődik, általában a végfelhasználók számára nyilvános bejelentés dátumán. Az ESET Connect API-kategóriák verziója átkerül a limitált támogatási területre, és az élettartam végéig tartó időszakban elérhető lesz. A limitált támogatás lejárta után az ESET Connect API-kategóriák verziója már nem lesz elérhető.

Programverziók számozása

Törő változások

Bármely változat, amely törő változást tartalmaz, egyértelműen meg lesz jelölve a dokumentációban.

Nem törő változások

Ha egy kiadás csak nem törő módosításokat tartalmaz, az API-kategória verziója változatlan marad. A részletek megtalálhatók az ESET Connect online súgódokumentációban.