Saltar al contenido principal
La Automation API utiliza versionado semántico.

​
Sobre el versionado de toda la API

Los cambios incompatibles solo se producen en nuevas versiones mayores de la API, con las siguientes excepciones:
  • Los endpoints que aún no están en uso pueden contener cambios incompatibles en una versión menor (1.x).
  • Las correcciones de seguridad críticas que rompan la compatibilidad hacia atrás pueden publicarse en una versión menor. Revise todos los cambios de la API en el changelog.
Los cambios incompatibles incluyen los siguientes tipos de cambios:
  • Eliminar una operación completa.
  • Eliminar o renombrar un parámetro.
  • Eliminar o renombrar un campo de respuesta.
  • Añadir un nuevo parámetro obligatorio.
  • Convertir en obligatorio un parámetro que antes era opcional.
  • Cambiar el tipo de un parámetro o de un campo de respuesta.
  • Eliminar valores de enum.
  • Añadir una nueva regla de validación a un parámetro existente.
  • Cambiar los requisitos de autenticación o autorización.
Cualquier cambio aditivo (no incompatible) estará disponible en todas las versiones soportadas de la API. Los cambios aditivos son cambios que no deberían romper una integración. Los cambios aditivos incluyen:
  • Añadir una operación.
  • Añadir un parámetro opcional.
  • Añadir una cabecera de solicitud opcional.
  • Añadir un campo de respuesta.
  • Añadir una cabecera de respuesta.
  • Añadir valores de enum.
Cuando Kameleoon publica una nueva versión mayor de la API, la versión anterior sigue siendo compatible durante al menos tres meses.

​
Especificar una versión de la API

Por defecto, https://api.kameleoon.com utiliza la versión más reciente de la API. Especifique una versión incluyéndola en la URL (por ejemplo, https://api.kameleoon.com/v1/). La siguiente versión mayor estará disponible en https://api.kameleoon.com/v2 una vez se publique.

​
Sobre el versionado por endpoint

Algunos endpoints permiten especificar una versión. Por ejemplo, puede preferir una versión más reciente de un endpoint concreto en lugar de la versión predeterminada de la API. Cuando esté disponible, use el parámetro version para especificar la versión de endpoint deseada. Cuando se publica una nueva versión mayor, todas las versiones anteriores se eliminan. Por ejemplo, si un endpoint tiene la versión 1 y la versión 2 en la versión 1.0.0 de la API, la versión 2.0.0 de la API contiene únicamente la versión más reciente de ese endpoint.