Saltar al contenido principal

Prefijo de versión

Todos los endpoints de la Scribe API incluyen un prefijo de versión en la 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
Lo siguiente no es incompatible y puede ocurrir en cualquier momento:
  • 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 (p. ej., v2):
  1. La versión anterior entra en un período de deprecación de al menos 6 meses
  2. Las versiones obsoletas devuelven un encabezado Sunset con la fecha prevista de eliminación
  3. Después del período de deprecación, la versión anterior puede eliminarse

Versiones actuales