Descripción general de la API de XL
Descripción general
La API de XL es una interfaz basada en REST que permite integrar directamente XL con otros sistemas y aplicaciones, así como intercambiar información con los dispositivos XL. La API de XL está disponible en los dispositivos XL con versiones de software 2.0 y posteriores.
La API de XL resulta especialmente útil para empresas de mayor tamaño con departamentos de TI bien dotados de personal que desean un control total sobre la integración. Las empresas que deseen utilizar la API deberían plantearse recurrir a los servicios de un desarrollador de software con experiencia.
Para las empresas que carezcan de estos recursos, recomendamos trabajar con los socios de integración de Vorne XL. Nuestros socios de integración de XL ofrecen una combinación de productos de software y servicios «llave en mano» (a menudo creados mediante conexiones API) y le ayudarán a integrar estrechamente XL con sus sistemas existentes, de modo que no tenga que dedicar recursos al mantenimiento de una conexión API.
La API de XL se puede utilizar para enviar información a los dispositivos XL. A continuación se indican cinco usos habituales de esta funcionalidad:
- Enviar la configuración de la pieza y del trabajo a XL (e iniciar una nueva serie de piezas).
- Enviar el nombre y el tamaño de un equipo a XL (y asignar estos ajustes al turno actual).
- Enviar un comando a XL para forzar un cambio a un estado de producción diferente y el motivo asociado (p. ej., «No programado» > «Sin producción»).
- Enviar un mensaje único al marcador LED durante un máximo de 30 segundos (p. ej., «¡Buen trabajo, equipo!»).
La API de XL también se puede utilizar para extraer información de XL para su uso en otro sistema (normalmente escribiendo en una base de datos). A continuación se indican tres usos habituales de esta funcionalidad:
- Extraer todos los datos y ajustes de XL (para utilizarlos como copia de seguridad del dispositivo).
- Extraer todas las métricas asociadas a un canal de datos (p. ej., hora, turno, día de producción, mes, pieza) a una base de datos SQL para utilizarlas con una plataforma de generación de informes de terceros.
- Extraer el estado de producción de XL actualmente activo y el motivo (para activar un evento en un sistema CMMS o ERP).
Más información
Para saber si la API de XL se adapta a su aplicación y para obtener una copia de la documentación de la API de XL, póngase en contacto con el servicio de asistencia de Vorne:
- Correo electrónico: support@vorne.com
- Teléfono: +1.630.875.3600
Actualizaciones
A medida que continuamos desarrollando y añadiendo funciones a XL, la API de XL estará sujeta a cambios.
Se han realizado los siguientes cambios en la API:
| Versión | Puntos de conexión | Explicación |
|---|---|---|
| 2.21 |
Marcador > Imagen gráfica HDMI |
Se ha añadido un nuevo punto final para devolver una imagen PNG de la salida HDMI actual del XL HD. |
| 2.20 |
Estado del proceso > Motivos |
Se ha actualizado el punto final para que devuelva una lista de los motivos del estado de los procesos activos. |
| 2.20 |
Proceso de fabricación > Factor de recuento de rendimiento |
Se ha añadido un nuevo punto final para actualizar el recuento esperado por ciclo y el recuento utilizado por ciclo. |
| 2.20 |
Cuadro de mando > Campos de la API |
Se ha añadido un nuevo punto final para obtener y configurar hasta doce campos personalizados para el cuadro de mando. |
| 2.19 |
Proceso de fabricación > Iniciar turno |
Se ha añadido un nuevo punto final para iniciar manualmente los turnos (con equipo opcional). |
| 2.18.2 |
Tiempo real > Esquema de datos en tiempo real Tiempo real > Datos en tiempo real |
Se han rediseñado por completo los puntos finales de Tiempo real con cambios importantes para hacer que los puntos finales sean jerárquicos, sustituir las matrices por objetos de pares clave/valor y añadir el estado de los pines de entrada. |
| 2.18.2 |
Tiempo real > Esquema de datos en tiempo real Tiempo real > Datos en tiempo real |
Se han añadido nuevos puntos de conexión para obtener los valores actuales de todas las categorías, los identificadores de eventos, las métricas y (opcionalmente) las métricas derivadas. |
| 2.18 |
Estado del proceso > Identificar el último estado del proceso |
Se ha añadido un nuevo punto final para obtener información sobre el evento más reciente para cada tipo de estado de proceso. |
| 2.18 |
Proceso de fabricación > Etiquetar una serie de piezas con un ID de trabajo |
Se ha añadido un nuevo punto final POST para etiquetar una pieza en producción con un ID de trabajo. |
| 2.17.1 |
Tabla > [Todos los puntos finales] Canal > [Todos los puntos finales] |
Eliminado:
|
| 2.17 |
Tabla > [Todos los puntos finales] Canal > [Todos los puntos finales] |
Añadido:
|
| 2.16 |
Tabla > [Todos los puntos finales] Canal > [Todos los puntos finales] |
Se ha cambiado el tipo de métrica de target_cycles de uint64 a double. |
| 2.16 | Gestión de datos > Reemplazar dispositivo | Se ha añadido un nuevo punto final. |
| 2.14 | Proceso de fabricación > Iniciar evento de parada | Se ha añadido un nuevo punto final. |
| 2.13 | Canal > Comentarios | Se ha añadido un nuevo punto final. |
| 2.13 | Canal > [Todos los puntos finales] | Se ha añadido la funcionalidad «include=comments» para obtener datos de comentarios junto con los datos del canal. |
| 2.12 |
Fabricación Proceso > Habilitar estado del proceso (estado de producción) |
Se ha añadido la posibilidad de habilitar los estados «en ejecución» y «inactivo», si la detección automática de ejecución está desactivada. |
| 2.12 | Canales > [Puntos finales de eventos] | Se han añadido los puntos finales de evento «anterior», «primero» y «último» para que coincidan con el punto final de evento «actual» ya existente. |
| 2.12 | Proceso de fabricación > Enviar rechazos con motivo | Se ha añadido un nuevo punto final POST para enviar el número de rechazos junto con un motivo de rechazo específico. |
| 2.11 | Proceso de fabricación > Inyectar entradas lógicas | Se ha añadido un nuevo punto final POST para inyectar un número determinado de entradas lógicas en un único pin en función de una carga útil. |
| 2.11 | Proceso de fabricación > Iniciar ciclo de producción (trabajo) | Cambios en la solicitud POST:
|
| 2.10 |
Tablas > [Todos los puntos finales] Canales > [Todos los puntos finales] |
Métricas añadidas:
Métricas eliminadas:
|
| 2,10 |
Tablas > Dimensiones Cuadro de mando > Imagen de superposición gráfica Cuadro de mando > Modo de superposición gráfica Marcador > Posición de la superposición gráfica Proceso de fabricación > Evento de división |
Se han añadido nuevos puntos finales. |
| 2.10 | Proceso de fabricación > Iniciar serie de piezas (trabajo) |
Cambios en la solicitud POST:
|
A efectos de claridad, el término «socio XL» se refiere a una empresa cuya relación con Vorne Industries se limita exclusivamente a la colaboración en la promoción, venta y asistencia técnica de los productos XL de Vorne. Vorne y sus socios XL son entidades totalmente independientes, y la relación entre Vorne y sus socios XL se limita a lo descrito en la frase anterior y no constituye una sociedad jurídica.
