ESET cloudconsoles applicatieprogrammeerinterfaces (API)
Om te begrijpen hoe veranderingen je integratie beïnvloeden, is het belangrijk om onderscheid te maken tussen de gateway en de applicatie-programmeerinterface (API) categorieën die deze bedient.
ESET Connect (gateway)
ESET Connect is een cloud-gehoste gateway die volledig door ESET wordt beheerd. Het fungeert als het toegangspunt tussen de client en de backend-diensten van de volgende ESET-clouddiensten:
ESET Connect API-categorieën
De Gateway biedt toegang tot specifieke sets API's, die zijn georganiseerd in categorieën.
Versiebeheer |
Elke API-categorie heeft zijn eigen onafhankelijke versieversie-levenscyclus. Dit is de versie die je specificeert in je codelink (bijv. /v1/groups). |
Impact |
Updates van ESET Connect API-categorieën kunnen de API-aanroepen wijzigen. |
Beleid voor End of Life |
Beleid voor het breaking changes
ESET kan wijzigingen aanbrengen zonder voorafgaande kennisgeving als deze als non-breaking wordt beschouwd.
ESET zal redelijke inspanningen leveren om u van tevoren te informeren over de brekende wijzigingen, met voldoende tijd om zich aan deze wijzigingen aan te passen. |
Een breaking verandering is een wijziging in application programming interfaces (API's) die mogelijk aanpassingen aan een applicatie vereist om verstoring van je integratie te voorkomen of om aanpassingen nodig te maken om compatibiliteit te behouden.
Hieronder volgen enkele voorbeelden van wijzigingen die wij als breaking changes beschouwen:
•gewijzigd responsformaat,
•veld hernoemd,
•veld verwijderd,
•wijziging van datatype,
•foutcodewijziging,
•verandering in bedrijfslogica.
Breaking changes kunnen ook worden veroorzaakt door wijzigingen met betrekking tot authenticatie, permissiescope, snelheidslimieten, transport-/URL-wijzigingen en andere factoren.
Een non-breaking verandering is een verandering waar je je naar eigen inzicht en tempo aan kunt aanpassen zonder onderbreking.
Hieronder volgen enkele voorbeelden van wijzigingen die wij niet als breaking changes beschouwen:
•nieuw veld toegevoegd,
•nieuwe optionele parameter toegevoegd,
•nieuwe toegevoegde waarde,
•verhoogd tarieflimiet,
•ondersteuning van meer formaten, enzovoort.
Overgangsperiode
Tijdens de overgangsperiode, aangezien de periode waarin een eerdere versie van een API-categorie beschikbaar blijft na de introductie van de nieuwe API-categorieversie of functionele vervanging, blijft de vorige versie beschikbaar voor een gedefinieerde, beperkte ondersteuningsperiode. ESET zal redelijke inspanningen leveren om compatibiliteit te waarborgen en klanten voldoende tijd te geven om zich aan deze veranderingen aan te passen.
De beperkte ondersteuning van de ESET Connect API Categorieën-versie begint op de aangekondigde datum, meestal op de publieke aankondigingsdatum voor eindklanten. De ESET Connect API-categorieën versie zal naar de Beperkte Ondersteuning verhuizen en zal beschikbaar zijn gedurende de hele periode tot de einddatum van de levensduur. Nadat de beperkte ondersteuning is verstreken, zal de ESET Connect API-categorieën versie niet langer beschikbaar zijn.
Regels voor versiebeheer
Breaking changes |
Elke versie met een breaking change wordt duidelijk gemarkeerd in de documentatie. |
Non-Breaking changes |
Als een release alleen non-breakng changes bevat, blijft de API-categorieversie hetzelfde. Details zijn te vinden in de ESET Connect Online-helpdocumentatie. |