Skip to main content
La versión mayor está en la ruta: /v1. Dentro de /v1 el contrato cambia solo de forma aditiva:
  • endpoints nuevos;
  • parámetros de consulta opcionales nuevos;
  • campos nuevos en las respuestas;
  • códigos de error nuevos para situaciones nuevas.
Construye tu cliente para que estos cambios no lo rompan: ignora los campos de respuesta que no conozcas y trata un código de error desconocido según su estado HTTP.

​
Cambios incompatibles

Cualquier otra cosa es un cambio incompatible: eliminar o renombrar un campo o un endpoint, cambiar el tipo o el significado de un campo, añadir un valor a una enumeración existente como status, o hacer obligatorio un parámetro. Un cambio incompatible se avisa con al menos 6 meses en el registro de cambios, con qué cambia, qué tienes que hacer y la fecha más temprana en que desaparece el comportamiento anterior. Cuando es posible, se publica como una versión mayor nueva (/v2) mientras /v1 sigue funcionando hasta esa fecha.

​
Dónde se anuncian los cambios

Cada cambio publicado de la API tiene una entrada con fecha en el registro de cambios. Producción y staging cambian a la vez, y staging se actualiza primero.