O OriginsNext fornece um conjunto de APIs públicas para integração de sistema para sistema. Essas APIs seguem uma estratégia de versionamento para garantir integrações estáveis, ao mesmo tempo em que entregam continuamente novos recursos e melhorias.
Por que o versionamento de API é importante?
Permite que os clientes adotem novos recursos em seu próprio ritmo
Cronogramas de atualização previsíveis quando as alterações podem quebrar as integrações existentes
Termos-chave
Termo | Definição |
Versão atual | Versão ativamente suportada com os recursos e melhorias mais recentes |
Obsoleta | Ainda suportada, mas será descontinuada após um período definido |
Alteração disruptiva (Breaking change) | Qualquer alteração no contrato da API (caminho, solicitação, resposta ou comportamento) que possa afetar as integrações atuais |
Importante: Uma nova versão da API só é introduzida se houver uma alteração disruptiva.
Suporte para versões obsoletas assim que uma nova versão é lançada:
A versão anterior torna-se obsoleta
Versões obsoletas permanecem suportadas por pelo menos 3 meses
Exemplo:
Se a versão v1 foi lançada em 1 de janeiro de 2024 e a v2 foi lançada em 1 de março de 2024, os clientes que usam a v1 terão suporte até pelo menos 2 de junho de 2024.
Como atualizar para a versão mais recente?
O OriginsNext usa versionamento baseado em caminho (ex: /v3/seu-endpoint). Siga os passos abaixo para atualizar:
Abra a documentação da API específica para o endpoint que você está usando (ex: API de Produção de Movimentos)
Verifique o número da versão no canto superior direito da documentação
Se a sua versão atual estiver desatualizada, localize a seção que detalha as alterações disruptivas
Revise as alterações introduzidas nas versões mais recentes para entender o que pode precisar ser atualizado na sua lógica de integração
Quando estiver pronto, atualize a URL da sua integração para a nova versão (ex: mude de /v2/ para /v3/)
Teste a integração com o ambiente Sandbox antes de mover para a produção
Você pode encontrar as URLs do Sandbox na documentação da API
Nota: Cada página de documentação da API é versionada. As alterações disruptivas listadas são relativas à versão anterior.