#Versionado

La API se versiona en la ruta: la versión actual es v1 y vive bajo https://api.clarisfy.com/api/v1.

#Cambios compatibles

Estos cambios pueden ocurrir dentro de v1 sin aviso previo. Diseña tu integración para tolerarlos:

  • Nuevos endpoints y nuevos recursos.
  • Nuevos campos opcionales en las respuestas.
  • Nuevos valores en enums existentes (por ejemplo un nuevo error.code).
  • Cambios en el texto de error.message (compara siempre contra error.code).
  • Nuevos tipos de evento de webhook.

#Cambios incompatibles

Un cambio que rompa compatibilidad (eliminar un campo, renombrar un recurso, cambiar la estructura del envelope) se publica bajo una nueva versión de ruta (v2). La versión anterior se mantiene durante el periodo de deprecación que anunciemos.

#Deprecaciones

Cuando deprequemos algo dentro de v1, lo anunciaremos en el Changelog y, cuando aplique, mediante el header Sunset en las respuestas afectadas, con la fecha a partir de la cual dejará de funcionar.