OriginsNext proporciona un conjunto de APIs públicas para la integración de sistema a sistema. Estas APIs siguen una estrategia de versionado para garantizar integraciones estables mientras se entregan continuamente nuevas características y mejoras.
¿Por qué es importante el versionado de API?
Permite a los clientes adoptar nuevas características a su propio ritmo
Plazos de actualización predecibles cuando los cambios pueden romper las integraciones existentes
Términos clave
Término | Definición |
Versión actual | Versión con soporte activo que incluye las últimas características y mejoras |
Obsoleta | Todavía con soporte, pero se retirará después de un período definido |
Cambio disruptivo (Breaking change) | Cualquier cambio en el contrato de la API (ruta, solicitud, respuesta o comportamiento) que pueda afectar las integraciones actuales |
Importante: Solo se introduce una nueva versión de la API si hay un cambio disruptivo.
Soporte para versiones obsoletas una vez que se lanza una nueva versión:
La versión anterior pasa a ser obsoleta
Las versiones obsoletas continúan con soporte durante al menos 3 meses
Ejemplo:
Si la versión v1 se lanzó el 1 de enero de 2024 y la v2 se lanzó el 1 de marzo de 2024, los clientes que usan v1 tendrán soporte hasta al menos el 2 de junio de 2024.
¿Cómo actualizar a la última versión?
OriginsNext utiliza el versionado basado en la ruta (p. ej., /v3/su-endpoint). Siga los pasos a continuación para actualizar:
Abra la documentación de la API específica para el endpoint que está utilizando (p. ej., 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 nuevas para comprender qué podría necesitar actualizar en su lógica de integración
Una vez listo, actualice la URL de su integración a la nueva versión (p. ej., cambie de /v2/ a /v3/)
Pruebe la integración con 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 enumerados son relativos a la versión anterior.