Interfacce di programmazione applicativa (API) alle console cloud ESET
Per capire come i cambiamenti influenzano la tua integrazione, è importante distinguere tra le categorie gateway e dell'interfaccia di programmazione applicativa (API) che serve.
ESET Connect (gateway)
ESET Connect è un gateway cloud gestito interamente da ESET. Agisce come punto di ingresso tra il client e i servizi backend dei seguenti servizi cloud ESET:
Categorie API di ESET Connect
Il Gateway fornisce accesso a specifici set di API, organizzate in Categorie.
Versioning |
Ogni categoria API ha il proprio ciclo di vita indipendente di versioning. Questa è la versione che specifichi nel link del tuo codice (ad esempio, /v1/groups). |
Impatto |
Gli aggiornamenti alle categorie API di ESET Connect possono modificare le chiamate API. |
Politica di fine del ciclo di vita |
Politica dei cambiamenti breaking
ESET può apportare modifiche senza preavviso se la modifica è considerata non infrangente.
|
ESET farà sforzi ragionevoli per informarti in anticipo delle modifiche di rompenza (breaking), con tempo sufficiente per adattarti a tali cambiamenti. |
Un cambiamento breaking è una modifica alle interfacce di programmazione applicativa (API) che può richiedere modifiche a un'applicazione per evitare interruzioni dell'integrazione o richiedere modifiche per mantenere la compatibilità.
Di seguito sono riportati alcuni esempi di cambiamenti che consideriamo cambiamenti di rompenza (breaking):
•formato di risposta modificato,
•campo rinominato,
•campo rimosso,
•cambio di tipo di dati,
•cambio del codice di errore,
•cambiamento nella logica aziendale.
Le modifiche breaking possono anche essere causate da modifiche relative all'autenticazione, all'ambito dei permessi, ai limiti di velocità, ai cambiamenti di trasporto/URL e ad altri fattori.
Un cambiamento non-breaking è un cambiamento a cui puoi adattarti a tua discrezione e al tuo ritmo senza interruzioni.
Di seguito sono riportati alcuni esempi di cambiamenti che riteniamo non essere cambiamenti di rompenza (breaking):
•nuovo campo aggiunto,
•aggiungimento di nuovo parametro opzionale,
•nuovo valore aggiunto,
•aumento del limite tariffario,
•supporto per più formati, ecc.
Periodo di transizione
Durante il periodo di transizione, poiché il periodo di tempo in cui una versione precedente di API Category rimane disponibile dopo l'introduzione della nuova versione o la sostituzione funzionale, la versione precedente continuerà a essere disponibile per un periodo di Supporto Limitato definito. ESET farà sforzi ragionevoli per garantire la compatibilità e fornire ai clienti tempo sufficiente per adattarsi a questi cambiamenti.
Il Supporto Limitato della versione ESET Connect API Categories inizia nella data annunciata, solitamente nella data di annuncio pubblico ai clienti finali. La versione delle categorie API ESET Connect passerà al Supporto Limitato e sarà disponibile per tutto il periodo fino alla sua data di fine vita. Dopo la scadenza del Supporto Limitato, la versione delle Categorie API ESET Connect non sarà più disponibile.
Criterio per il versioning
Cambiamenti breaking |
Qualsiasi versione che contenga una modifica interrotta sarà chiaramente indicata nella documentazione. |
Cambiamenti non-breaking |
Se una release contiene solo cambiamenti non interrotti, la versione della Categoria API rimane la stessa. I dettagli sono disponibili nella documentazione online di assistenza ESET Connect. |