Versionado de la API
La API de Vesvank implementa un sistema de versionado basado en la URL, actualmente en la versión v1. Este enfoque garantiza la estabilidad y previsibilidad para los integradores, permitiendo:
- Mantener la compatibilidad con integraciones existentes.
- Introducir mejoras y cambios significativos sin afectar a los clientes actuales.
- Facilitar la migración progresiva hacia nuevas versiones.
Estructura de Versionado
Section titled “Estructura de Versionado”Todas las rutas de la API incluyen el prefijo de versión, por ejemplo:
https://<subdomain>.vesvank.com/api/v1/...Convenciones de Versionado
Section titled “Convenciones de Versionado”- Prefijo de versión: Todas las URLs de la API incluyen
/api/v1/. - Cambios incompatibles: Cualquier cambio que rompa la compatibilidad (breaking change) dará lugar a una nueva versión mayor (por ejemplo,
/api/v2/). - Soporte de versiones anteriores: Las versiones antiguas permanecerán activas durante un período de transición para permitir la migración de los clientes.
- Aviso de deprecación: El fin de soporte para versiones antiguas será anunciado con suficiente antelación a través de nuestros canales oficiales y la documentación.
Próximas Versiones
Section titled “Próximas Versiones”Cuando sea necesario introducir cambios significativos, se publicará una nueva versión (por ejemplo, v2), manteniendo la versión anterior disponible durante un tiempo prudencial para facilitar la transición.