Panoramica sull'API XL
Panoramica
L'API XL è un'interfaccia basata su REST che consente di integrare direttamente XL con altri sistemi e applicazioni, nonché di importare ed esportare informazioni dai dispositivi XL. L'API XL è disponibile sui dispositivi XL con versione software 2.0 e successive.
L’API XL è particolarmente utile per le aziende di grandi dimensioni con reparti IT ben attrezzati che desiderano avere il controllo totale sull’integrazione. Le aziende che intendono utilizzare l’API dovrebbero prevedere di avvalersi dei servizi di uno sviluppatore software esperto.
Per le aziende che non dispongono di tali risorse, consigliamo di collaborare con i partner di integrazione Vorne XL. I nostri partner di integrazione XL offrono una combinazione di prodotti software e servizi chiavi in mano (spesso realizzati tramite connessioni API) e vi aiuteranno a integrare strettamente XL con i vostri sistemi esistenti, in modo che non sia necessario dedicare risorse alla manutenzione di una connessione API.
L’API XL può essere utilizzata per inviare informazioni ai dispositivi XL. Ecco cinque utilizzi comuni di questa funzionalità:
- Inserire le impostazioni relative ai pezzi e ai lavori in XL (e avviare una nuova produzione di pezzi).
- Inviare il nome e la dimensione di un team a XL (e assegnare queste impostazioni al turno corrente).
- Inviare un comando a XL per forzare il passaggio a uno stato di produzione diverso e specificarne il motivo (ad es. Non programmato > Nessuna produzione).
- Inviare un messaggio personalizzato sul tabellone a LED per un massimo di 30 secondi (ad es. “Ottimo lavoro, squadra!”).
L’API di XL può essere utilizzata anche per estrarre informazioni da XL da utilizzare in un altro sistema (normalmente scrivendo in un database). Ecco tre utilizzi comuni di questa funzionalità:
- Estrarre tutti i dati e le impostazioni da XL (da utilizzare come backup del dispositivo).
- Estrarre tutte le metriche associate a un canale dati (ad es. ora, turno, giorno di produzione, mese, parte) in un database SQL per utilizzarle con una piattaforma di reportistica di terze parti.
- Estrarre lo stato di produzione XL attualmente attivo e il motivo (per attivare un evento in un sistema CMMS o ERP).
Ulteriori informazioni
Per verificare se l’API XL è adatta alla vostra applicazione e per ottenere una copia della documentazione dell’API XL, contattate l’assistenza Vorne:
- E-mail: support@vorne.com
- Telefono: +1.630.875.3600
Aggiornamenti
Man mano che continuiamo a sviluppare e aggiungere funzionalità a XL, l'API XL sarà soggetta a modifiche.
Sono state apportate le seguenti modifiche all'API:
| Versione | Endpoint | Spiegazione |
|---|---|---|
| 2.21 |
Tabellone > Immagine grafica HDMI |
Aggiunto un nuovo endpoint per restituire un'immagine PNG dell'attuale uscita HDMI dell'XL HD. |
| 2.20 |
Stato del processo > Motivi |
Endpoint aggiornato per restituire un elenco dei motivi relativi allo stato dei processi attivi. |
| 2.20 |
Processo di produzione > Fattore di conteggio delle prestazioni |
Aggiunto un nuovo endpoint per aggiornare il conteggio previsto per ciclo e il conteggio utilizzato per ciclo. |
| 2.20 |
Quadro di controllo > Campi API |
Aggiunto un nuovo endpoint per recuperare e configurare fino a dodici campi personalizzati per il quadro di controllo. |
| 2.19 |
Processo di produzione > Avvio turno |
Aggiunto un nuovo endpoint per l’avvio manuale dei turni (con squadra opzionale). |
| 2.18.2 |
Tempo reale > Schema dati in tempo reale Tempo reale > Dati in tempo reale |
Endpoint in tempo reale completamente rielaborati con modifiche sostanziali per rendere gli endpoint gerarchici, sostituire gli array con oggetti costituiti da coppie chiave/valore e aggiungere lo stato dei pin di ingresso. |
| 2.18.2 |
Tempo reale > Schema dei dati in tempo reale Tempo reale > Dati in tempo reale |
Aggiunti nuovi endpoint per ottenere i valori correnti di tutte le categorie, gli ID degli eventi, le metriche e (facoltativamente) le metriche derivate. |
| 2.18 |
Stato del processo > Identifica l'ultimo stato del processo |
Aggiunto un nuovo endpoint per ottenere informazioni sull'evento più recente per ciascun tipo di stato del processo. |
| 2.18 |
Processo di produzione > Assegnazione di un ID lavoro a una serie di pezzi |
Aggiunto un nuovo endpoint POST per contrassegnare un pezzo in lavorazione con un ID lavoro. |
| 2.17.1 |
Tabella > [Tutti gli endpoint] Canale > [Tutti gli endpoint] |
Rimosso:
|
| 2.17 |
Tabella > [Tutti gli endpoint] Canale > [Tutti gli endpoint] |
Aggiunto:
|
| 2.16 |
Tabella > [Tutti gli endpoint] Canale > [Tutti gli endpoint] |
Modificato il tipo di metrica di target_cycles da uint64 a double. |
| 2.16 | Gestione dati > Sostituisci dispositivo | Aggiunto un nuovo endpoint. |
| 2.14 | Processo di produzione > Avvia evento di spegnimento | Aggiunto un nuovo endpoint. |
| 2.13 | Canale > Commenti | Aggiunto un nuovo endpoint. |
| 2.13 | Canale > [Tutti gli endpoint] | Aggiunta la funzionalità include=comments per ottenere i dati dei commenti insieme a quelli del canale. |
| 2.12 |
Produzione Processo > Abilita stato del processo (stato di produzione) |
Aggiunta la possibilità di abilitare gli stati “in esecuzione” e “inattivo”, se il rilevamento automatico dell’esecuzione è disabilitato. |
| 2.12 | Canali > [Endpoint degli eventi] | Aggiunti gli endpoint di evento “precedente”, “primo” e “ultimo” a corredo dell’endpoint di evento “corrente” già esistente. |
| 2.12 | Processo di produzione > Invia scarti con motivazione | Aggiunto un nuovo endpoint POST per inviare il numero di scarti con un motivo specificato. |
| 2.11 | Processo di produzione > Inserimento di input logici | Aggiunto un nuovo endpoint POST per iniettare un determinato numero di ingressi logici su un singolo pin in base a un payload. |
| 2.11 | Processo di produzione > Avvio della produzione di un componente (lavoro) | Modifiche alla richiesta POST:
|
| 2.10 |
Tabelle > [Tutti gli endpoint] Canali > [Tutti gli endpoint] |
Metriche aggiunte:
Metriche rimosse:
|
| 2.10 |
Tabelle > Dimensioni Tabellone > Immagine di sovrapposizione grafica Quadro dei punteggi > Modalità sovrapposizione grafica Tabellone > Posizione sovrapposizione grafica Processo di produzione > Evento di suddivisione |
Aggiunti nuovi endpoint. |
| 2.10 | Processo di produzione > Avvio della produzione del pezzo (lavoro) |
Modifiche alla richiesta POST:
|
Per chiarezza, il termine “Partner XL” si riferisce a un’azienda il cui rapporto con Vorne Industries è esclusivamente quello di collaboratore nella promozione, nella vendita e nell’assistenza dei prodotti XL di Vorne. Vorne e i suoi Partner XL sono entità completamente indipendenti, e il rapporto tra Vorne e i suoi Partner XL è limitato a quanto descritto nella frase precedente e non costituisce una partnership giuridica.
