Referencia API
Versionado
Política de versionado de la API de Sifende — versiones, breaking changes y deprecaciones.
Versión actual
v1 — todos los endpoints usan el prefijo /api/v1/.
Política de breaking changes
Un cambio no es breaking si:
- Se agregan nuevos campos opcionales al request o response
- Se agregan nuevos endpoints
- Se agregan nuevos valores a enumeraciones existentes
Un cambio es breaking si:
- Se eliminan o renombran campos existentes
- Se cambia el tipo de un campo
- Se cambia el comportamiento observable de un endpoint
- Se remueve un endpoint
Los breaking changes se anuncian con al menos 30 días de anticipación vía email y en el Changelog.
Deprecación
Cuando un endpoint se depreca:
- Se documenta con una nota de deprecación en esta documentación
- Se retorna el header
Sunsetcon la fecha de remoción planeada - Se retorna el header
Deprecationcon la fecha en que fue deprecado
Versiones futuras
Cuando se lance v2, los endpoints v1 seguirán funcionando durante el período de migración. La documentación de v1 permanecerá disponible con un banner de deprecación.