OriginsNext ofrece un conjunto de APIs públicas para la integración sistema a sistema. Estas APIs siguen una estrategia de versionado para garantizar integraciones estables mientras se entregan continuamente nuevas funciones y mejoras.
Por qué es importante el versionado de API
El versionado de API es importante porque:
Permite que los clientes adopten nuevas funciones a su propio ritmo.
Ofrece plazos de actualización predecibles cuando un cambio puede afectar integraciones existentes.
Términos clave
Estos son los términos clave del versionado de API y su significado:
Término | Definición |
Versión actual | Versión activamente soportada con las últimas funciones y mejoras |
Deprecada | Aún soportada, pero se retirará después de un período definido |
Cambio disruptivo | Cualquier cambio en el contrato de la API (ruta, solicitud, respuesta o comportamiento) que pueda afectar las integraciones actuales |
Importante: una nueva versión de API solo se introduce cuando hay un cambio disruptivo.
Soporte para versiones deprecadas
Cuando se lanza una nueva versión, la versión anterior pasa a estar deprecada, y el soporte funciona de la siguiente manera:
La versión anterior pasa a estar deprecada.
Las versiones deprecadas permanecen soportadas durante al menos 3 meses.
Ejemplo: si la versión v1 fue lanzada el 1 ene 2024 y la v2 fue lanzada el 1 mar 2024, los clientes que usan v1 tienen soporte hasta al menos el 2 jun 2024.
Cómo actualizar a la última versión
OriginsNext utiliza versionado basado en ruta (por ejemplo, /v3/su-endpoint). Para actualizar a la última versión:
Abra la documentación de la API específica para el endpoint que está utilizando (por ejemplo, API de Producción de Movimientos).
Verifique el número de versión en la esquina superior derecha de la documentación.
Si su versión actual está desactualizada, localice la sección que detalla los cambios disruptivos.
Revise los cambios introducidos en las versiones más recientes para entender qué puede necesitar actualizarse en su lógica de integración.
Cuando esté listo, actualice la URL de integración a la nueva versión (por ejemplo, cambie de /v2/ a /v3/).
Pruebe la integración en el entorno Sandbox antes de pasar a producción. Puede encontrar las URLs de Sandbox en la documentación de la API.
Nota: cada página de documentación de la API está versionada. Los cambios disruptivos listados son relativos a la versión anterior.