Skip to main content
La X API utiliza números de versión en las rutas de los endpoints para ofrecer estabilidad y, al mismo tiempo, permitir la evolución. Comprender nuestra estrategia de versionado te ayuda a planificar tus integraciones y mantenerte al día.

Versiones actuales

Usa X API v2 para todos los proyectos nuevos. Es donde se lanzan todas las nuevas funciones.

Versión en las URL

El número de versión aparece en la ruta del endpoint:

Cambios incompatibles vs. compatibles

Cambios incompatibles con versiones anteriores (requieren actualizaciones de código)

Estos cambios solo ocurren en versiones principales:
  • Eliminar un endpoint
  • Eliminar un campo de la respuesta
  • Eliminar un parámetro de consulta
  • Agregar un nuevo parámetro obligatorio
  • Cambiar el tipo de datos de un campo
  • Cambiar el nombre de un campo o recurso
  • Cambiar códigos de respuesta o tipos de error
  • Modificar scopes de autorización

Cambios retrocompatibles (aditivos)

Estos pueden ocurrir en cualquier momento sin cambios de versión:
  • Agregar un nuevo endpoint
  • Agregar un nuevo parámetro opcional
  • Agregar un nuevo campo de respuesta
  • Agregar nuevos scopes de OAuth
  • Cambiar el texto del mensaje de error
  • Establecer campos como null por razones de privacidad o seguridad

Calendario de lanzamientos


Política de obsolescencia

Cuando lanzamos una nueva versión principal:
  1. Obsolescencia: La versión anterior se marca como obsoleta
  2. Periodo de soporte: La versión obsoleta continúa funcionando durante un periodo definido
  3. Retirada: La versión obsoleta se elimina

Definiciones


Mantenerse informado

Recibe notificaciones sobre los cambios:

Registro de cambios

Todos los cambios y actualizaciones de la plataforma.

Anuncios del foro

Avisos de cambios incompatibles.

@XDevelopers

Noticias y actualizaciones de la plataforma.

Boletín

Resumen mensual.

Recursos de migración

Cuando se publica una nueva versión, proporcionamos:
  • Guías de migración: instrucciones de actualización paso a paso
  • Asignación de endpoints: equivalencias de v1 a v2
  • Cambios en el formato de datos: diferencias en el modelo de objetos

Resumen de la migración

Recomendaciones actuales para la migración.

Mapa de endpoints

Asignación de endpoints de v1 a v2.

Mejores prácticas

Usa v2

Inicia los nuevos proyectos en la versión más reciente.

Sigue los anuncios

Suscríbete al registro de cambios y a las actualizaciones del foro.

Prueba los cambios

Prueba los cambios en desarrollo antes de aplicarlos en producción.

Planifica las migraciones

No esperes a que se declare obsoleta para actualizar.