Saltar al contenido
Vintu API
Tema de la documentación
Ir a la app

Versionado

La versión va en la ruta: todas las operaciones de esta documentación están bajo /v1.

Cambios que no cambian de versión

Dentro de /v1 pueden aparecer, sin aviso previo:

  • campos nuevos en las respuestas;
  • operaciones nuevas;
  • parámetros opcionales nuevos;
  • códigos de error nuevos.

Para que tu integración no se rompa con ellos, ignora los campos que no conozcas y trata un código de error desconocido según su estado HTTP (ver Errores).

Cambios que sí cambian de versión

Quitar o renombrar un campo, cambiar su tipo o su significado, o hacer obligatorio un parámetro son cambios incompatibles. Llegan en una versión nueva de la ruta, o como retiro anunciado dentro de /v1 con seis meses de aviso.

Todos los cambios se publican en el registro de cambios.