Léeme

Importante:

Planeamos actualizar la versión Swagger de Orchestrator a Swagger 3.0. Actualmente, las API de Orchestrator se definen utilizando Swagger 2.0.

No se preocupe por la compatibilidad con versiones anteriores de sus clientes API existentes: nos aseguraremos de que la API siga siendo compatible.

Recomendamos utilizar tus clientes anteriores, ya que los cambios de JSON no los alteran gracias a nuestra estructura de solicitudes que es compatible con versiones anteriores.

Después de la actualización de Swagger 3.0, todos los clientes API regenerados basados en la nueva definición JSON tendrán que reajustarse.

Si planeas integrar nuestras API con tu cliente, debes conocer las posibles actualizaciones y cambios que pueden ocurrir en la definición de Swagger, los esquemas JSON o los puntos finales de la API.

La siguiente lista proporciona información y recomendaciones sobre los cambios de Swagger. Si tiene más preguntas, póngase en contacto con nuestro equipo de soporte.

Información y recomendaciones sobre los cambios de Swagger

1. La descripción de la API de JSON representada en el documento JSON de Swagger puede cambiar en cualquier momento. Sin embargo, describirá la misma API subyacente para garantizar la compatibilidad con versiones anteriores.
2. La interfaz de Swagger y el JSON correspondiente se generan en función de los puntos de conexión actuales y siempre publicamos la última versión. Para garantizar la compatibilidad con versiones anteriores, admitimos la misma estructura de solicitud.
3. Como alternativa a los clientes API generados en tiempo de ejecución, utiliza clientes API de tiempo fijo o de compilación. Al hacerlo, se reduce la dependencia y se evitan actualizaciones de automatización importantes en caso de que cambie la definición de la API o de Swagger.
4. Los elementos marcados como obsoletos están disponibles durante un tiempo limitado, después del cual se eliminan de la definición de Swagger y la API de JSON.
5. Cada vez que ciertas API cambian internamente, se publica una nueva versión de la API de Swagger. El número de versión de la API no influye en el uso de la API del cliente. No recomendamos confiar en el control de versiones de la API.

Ejemplos de API

Los ejemplos proporcionados en el documento de referencia de Orchestrator existente describen escenarios y puntos finales complejos.

Puedes ver todas las API disponibles en el Swagger JSON, que contiene las últimas actualizaciones.