La interfaz de usuario Swagger

La Swagger UI es una herramienta que proporciona una interfaz fácil de usar para interactuar con la API de exportación.

La Swagger UI proporciona documentación para cada endpoint, incluidos los formatos de solicitud y respuesta. También le permite probar la API de exportación directamente, sin necesidad de desarrollar su propia aplicación.

Puede acceder a Swagger UI en el servidor octoplant utilizando el siguiente enlace:

https://{nombre o dirección IP del servidor octoplant}:64023/swagger-ui

El puerto 64023 es el puerto predeterminado asignado a la API en el servidor de octoplant.

Trabajar con Swagger UI

Después de abrir Swagger UI, primero debe autenticarse con el servidor.

1. En la esquina superior derecha de la Swagger UI, seleccione el botón Authorize.

2. En el cuadro de diálogo, introduzca sus credenciales de usuario para el servidor de octoplant.

   No es necesario que introduzca aquí el ID de cliente y el secreto de cliente, ya están predefinidos.

3. Seleccione Login.

Puede encontrar toda la información relevante para la API de exportación en la sección Swagger UI.

La sección Export contiene cuatro secciones:

• La solicitud POST con la creación del archivo JSON y el inicio del proceso
• Las dos solicitudes GET para solicitar el estado actual de la exportación y descargar la exportación finalizada
• Y la solicitud POST intermedia para cancelar la tarea, por ejemplo, si ya no se necesita.

En todas las secciones, puede probar la solicitud utilizando el botón Try it out situado en la esquina superior derecha de la sección.