Prefijo de versión
Todos los endpoints de la Synapse API incluyen un prefijo de versión en su ruta. La versión estable actual es v1.Garantía de estabilidad
Dentro de una versión, la API no introducirá cambios incompatibles. Se consideran incompatibles:- Eliminar un endpoint o método HTTP
- Eliminar o renombrar un campo de respuesta
- Cambiar el tipo de un campo existente
- Agregar un nuevo campo obligatorio en la solicitud
- Cambiar códigos de error para escenarios existentes
- Agregar nuevos campos opcionales en la solicitud
- Agregar nuevos campos en la respuesta
- Agregar nuevos endpoints
- Agregar nuevos códigos de error para nuevos escenarios
Política de deprecación
Cuando se publica una nueva versión (ej.v2):
- La versión anterior entra en un período de deprecación de al menos 6 meses
- Las versiones deprecadas retornan un header
Sunsetcon la fecha planeada de eliminación - Después del período de deprecación, la versión antigua puede ser eliminada
Versiones actuales
| Versión | Estado | URL base |
|---|---|---|
v1 | Estable | https://synapse.telepatia.ai/v1 |