Interfaces de programação de aplicações (API) dos consoles em nuvem ESET
Para entender como as mudanças afetam sua integração, é importante distinguir entre as categorias gateway e da interface de programação de aplicações (API) que ela atende.
ESET Connect (gateway)
O ESET Connect é um gateway hospedado na nuvem gerenciado inteiramente pela ESET. Ele atua como ponto de entrada entre o cliente e os serviços backend dos seguintes serviços em nuvem ESET:
Categorias da API ESET Connect
O Gateway oferece acesso a conjuntos específicos de APIs, que são organizados em Categorias.
Versionamento |
Cada categoria de API tem seu próprio ciclo de vida independente de versionamento. Essa é a versão que você especifica no link do seu código (por exemplo, /v1/groups). |
Impacto |
Atualizações das Categorias de API do ESET Connect podem alterar as chamadas de API. |
Política de fim da vida útil |
Política de mudança inovadora
A ESET pode fazer alterações sem aviso prévio se a alteração for considerada não quebrante.
|
A ESET fará esforços razoáveis para notificá-lo sobre mudanças em risco com antecedência, com tempo suficiente para se adaptar a essas mudanças. |
Uma mudança quebranta é uma alteração nas interfaces de programação de aplicações (APIs) que pode exigir modificações em uma aplicação para evitar interrupções na sua integração ou exigir alterações para manter a compatibilidade.
A seguir, alguns exemplos de mudanças que consideramos mudanças recentes:
•Mudança no formato da resposta,
•campo renomeado,
•campo removido,
•mudança no tipo de dado,
•mudança de código de erro,
•mudança na lógica de negócios.
Alterações quebrantes também podem ser causadas por alterações relacionadas à autenticação, escopo de permissões, limites de taxa, mudanças de transporte/URL e outros fatores.
Uma mudança que não quebra é uma mudança à qual você pode se adaptar à sua própria discrição e ritmo, sem interrupções.
A seguir, alguns exemplos de mudanças que consideramos não serem mudanças de quebra:
•novo campo adicionado,
•novo parâmetro opcional adicionado,
•novo valor agregado,
•aumento do limite de tarifa,
•suporte a mais formatos, etc.
Período de transição
Durante o período de transição, como o período em que uma versão anterior de uma Categoria de API permanece disponível após a introdução da nova versão da Categoria de API ou substituição funcional, a versão anterior continuará disponível por um período definido e limitado de Suporte. A ESET fará esforços razoáveis para garantir a compatibilidade e proporcionar aos clientes tempo suficiente para se adaptarem a essas mudanças.
O Suporte Limitado da versão ESET Connect API Categories começa na data anunciada, geralmente na data de anúncio público para clientes finais. A versão das Categorias da API ESET Connect será transferida para o Suporte Limitado e estará disponível durante todo o período até sua data de fim de vida. Após o término do Suporte Limitado, a versão das Categorias da API ESET Connect não estará mais disponível.
Política de versionamento
Mudanças Recentes |
Qualquer versão contendo uma alteração quebrada estará claramente marcada na documentação. |
Mudanças Ininterruptas |
Se uma versão contém apenas mudanças não interrompidas, a versão da Categoria API permanece a mesma. Detalhes podem ser encontrados na documentação de ajuda do ESET Connect Online. |