O OriginsNext oferece um conjunto de APIs públicas para integração sistema a sistema. Essas APIs seguem uma estratégia de versionamento para garantir integrações estáveis enquanto entregam continuamente novos recursos e melhorias.
Por que o versionamento de API é importante
O versionamento de API é importante porque:
Permite que os clientes adotem novos recursos no seu próprio ritmo.
Oferece prazos de atualização previsíveis quando uma mudança pode afetar integrações existentes.
Termos principais
Estes são os principais termos de versionamento de API e o que significam:
Termo | Definição |
Versão atual | Versão ativamente suportada com os recursos e melhorias mais recentes |
Descontinuada | Ainda suportada, mas será removida após um período definido |
Mudança disruptiva | Qualquer alteração no contrato da API (caminho, requisição, resposta ou comportamento) que possa afetar as integrações atuais |
Importante: uma nova versão da API só é introduzida quando há uma mudança disruptiva.
Suporte a versões descontinuadas
Quando uma nova versão é lançada, a versão anterior passa a ser descontinuada, e o suporte funciona da seguinte forma:
A versão anterior passa a ser descontinuada.
Versões descontinuadas permanecem suportadas por pelo menos 3 meses.
Exemplo: se a versão v1 foi lançada em 1 jan 2024 e a v2 foi lançada em 1 mar 2024, os clientes que usam v1 são suportados até pelo menos 2 jun 2024.
Como atualizar para a versão mais recente
O OriginsNext usa versionamento baseado em caminho (por exemplo, /v3/seu-endpoint). Para atualizar para a versão mais recente:
Abra a documentação da API específica para o endpoint que você está usando (por exemplo, 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 mudanças disruptivas.
Revise as mudanças 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 de integração para a nova versão (por exemplo, mude de /v2/ para /v3/).
Teste a integração no ambiente Sandbox antes de migrar para produção. Os URLs de Sandbox podem ser encontrados na documentação da API.
Nota: cada página de documentação da API é versionada. As mudanças disruptivas listadas são relativas à versão anterior.