Connettore OpenBOM

Connettore OpenBOM

Integrare Tulip con OpenBOM utilizzando il connettore HTTP di Tulip

Introduzione

OpenBOM è una tecnologia di collaborazione e gestione dei dati in tempo reale basata su cloud che consente di gestire parti, cataloghi, distinte base, inventari e ordini di acquisto tra reti di ingegneri, responsabili della catena di fornitura e produttori a contratto. L'obiettivo di questo connettore è integrare OpenBOM con Tulip utilizzando i connettori HTTP di Tulip e fornire un connettore OpenBOM pronto per l'uso che può essere importato nella vostra istanza.

Scopo

1. Verranno evidenziate diverse funzioni del connettore HTTP che possono essere costruite effettuando chiamate HTTP agli endpoint di OpenBOM per estrarre informazioni sulle distinte dei materiali (BOM) configurate, sui cataloghi mantenuti e per estrarre informazioni sulle distinte degli ordini di produzione rilasciate in OpenBOM.
2. Le applicazioni Tulip possono essere costruite per personalizzare le istruzioni di lavoro per gli operatori in officina, che possono ottenere informazioni sugli ordini di produzione, evidenziando le parti necessarie agli operatori per assemblare i prodotti e completare l'ordine di produzione in officina. Sfruttando i cataloghi in OpenBOM, mostreremo come i responsabili dell'officina possono mantenere un inventario in tempo reale delle diverse parti necessarie per assemblare il prodotto in officina.

API Doc

Le seguenti funzioni dei connettori evidenziate in questo documento hanno sfruttato i documenti API di OpenBOM.

Prerequisiti

1. Creare un account su OpenBOM e configurare i cataloghi e le distinte base di OpenBOM per il prodotto da assemblare in officina.
2. È necessario generare una chiave API che viene utilizzata nei connettori Tulip per stabilire connessioni con OpenBOM.
3. Utilizzando l'autenticazione di base (nome utente e password), si ottiene il token di accesso (spiegato di seguito) che verrà passato come intestazione della richiesta in tutte le funzioni del connettore.

Dettagli della connessione Tulip

Le seguenti informazioni devono essere configurate sul connettore HTTP di Tulip.

1. In esecuzione su: Host del connettore cloud
2. Host: developer-api.openbom.com
3. Porta: 443
4. TLS: Sì
5. Autenticazione: No Auth
6. Intestazioni: x-openbom-appkey

Funzioni del connettore

Ottenere il token di accesso

Scopo

1. Ottenere il token di accesso che sarà usato come intestazione della richiesta in tutte le funzioni successive del connettore.
2. Il token di accesso scade ogni 24 ore. Dopo aver eseguito questa funzione del connettore, OpenBOM restituisce il token di accesso che può essere memorizzato in una variabile Tulip che può essere utilizzata dinamicamente da tutte le funzioni del connettore successive come intestazione della richiesta.

Endpoint e intestazioni

1. Una chiamata POST all'endpoint: https://developer-api.openbom.com:443/login
2. Intestazione della richiesta: x-openbom-appkey
3. Corpo della richiesta: ContentType: JSON nome utente e password come chiavi

Estrattore di output richiesto

1. Token di accesso - Il Token di accesso restituito sarà utilizzato in tutte le funzioni del connettore secondario.

Ottenere un elenco di cataloghi

Scopo

1. Questo endpoint fornisce un elenco di cataloghi disponibili nel profilo OpenBOM dell'utente.
2. L'elenco può essere utilizzato per estrarre gli ID dei cataloghi che possono essere utilizzati per sfruttare cataloghi specifici per estrarre l'inventario corrente di diversi materiali e aggiornare le diverse proprietà all'interno del catalogo in tempo reale.

Endpoint e intestazioni

1. Una chiamata GET all'endpoint: https://developer-api.openbom.com:443/catalogs
2. Intestazioni della richiesta: x-openbom-appkey, x-openbom-accesstoken

Input richiesto

1. Token di accesso da passare da una variabile che è richiesta come intestazione della richiesta per la chiamata HTTP all'endpoint di cui sopra.

Estrattori di output richiesti

1. CatalogId - Può essere usato per richiamare cataloghi specifici di interesse.

Ottenere un elenco di distinte base

Scopo

1. Questo endpoint fornisce un elenco di distinte base disponibili nel profilo OpenBOM dell'utente.
2. L'elenco può essere utilizzato per estrarre gli ID delle distinte o i nomi delle distinte che possono essere utilizzati per sfruttare le distinte specifiche per ottenere informazioni sulle diverse parti necessarie per completare l'assemblaggio di un'unità in officina.

Endpoint e intestazioni

1. Una chiamata GET all'endpoint: https://developer-api.openbom.com:443/boms
2. Intestazioni della richiesta x-openbom-appkey, x-openbom-accesstoken

Input richiesto

1. Token di accesso da passare da una variabile che è richiesta come intestazione della richiesta per la chiamata HTTP all'endpoint di cui sopra.

Estrattori di output richiesti

1. BOMId - Può essere usato per richiamare specifiche distinte di interesse.
2. Name - Può essere usato per fare un POST per chiamare una specifica distinta base passando la proprietà Name.

Ottenere la distinta base dell'ordine di produzione

Scopo

1. Questa funzione estrae la distinta base dell'ordine di produzione quando la distinta base specifica per l'assemblaggio di un'unità viene rilasciata alla produzione su OpenBOM.
2. Questa funzione di raccordo estrae importanti dettagli (Nome, BOMID, Numero di unità) sull'ordine di produzione, che verranno passati dinamicamente per richiamare uno specifico ID di distinta base che conterrà tutte le informazioni sul numero totale di parti necessarie all'operatore per completare l'intero ordine di produzione.

Punto finale e intestazioni

1. Una chiamata GET all'endpoint: https://developer-api.openbom.com:443/orderboms
2. Intestazioni della richiesta: x-openbom-appkey, x-openbom-accesstoken

Input richiesto

1. Token di accesso da passare tramite una variabile che è richiesta come intestazione della richiesta per la chiamata HTTP all'endpoint di cui sopra.

Estrattori di output richiesti

1. Name - Può essere usato per ottenere i dettagli di una specifica distinta base di produzione passando il nome all'endpoint specifico della distinta base.
2. BOMID - Serve per ottenere tutti i dettagli di una specifica distinta base di produzione, passando l'ID all'endpoint specifico della distinta.
3. numUnits - Questa proprietà può essere utilizzata per indicare il numero di unità da produrre in officina per un singolo ordine di produzione.

Ottenere una distinta base specifica

Scopo

1. Questa funzione ottiene le proprietà di tutti i diversi materiali inclusi in una specifica distinta base per l'assemblaggio di un'unità.
2. Le righe restituite da OpenBOM possono essere analizzate in Tulip, che viene utilizzato per visualizzare la quantità delle diverse materie prime necessarie per completare l'ordine di produzione, oltre a tutte le altre proprietà della distinta base restituite da OpenBOM, a seconda di come è configurata la distinta base.

Endpoint e intestazioni

1. Una chiamata GET all'endpoint: https: //developer-api.openbom.com:443/bom/{bomid}
2. Intestazione della richiesta: x-openbom-appkey, x-openbom-accesstoken
3. Parametro URL: {bomid} - Sarà passato come input.

Input richiesti

1. Token di accesso da passare come variabile, richiesto come intestazione della richiesta per la chiamata HTTP all'endpoint di cui sopra.
2. BOMID - Per ottenere le informazioni sulla specifica distinta base di interesse.

Output richiesti

1. Righe restituite da OpenBOM per una specifica distinta base che include le proprietà dei diversi materiali che ne fanno parte.
2. Gli utenti possono analizzare i dettagli specifici restituiti da OpenBOM in base al caso d'uso.

Ottenere una distinta base specifica per nome

Scopo

1. Questa funzione ottiene le proprietà di tutti i diversi materiali inclusi in una specifica distinta base per l'assemblaggio di un'unità passando il nome della distinta base al posto dell'id.
2. Le righe restituite da OpenBOM possono essere analizzate in Tulip che vengono utilizzate per visualizzare la quantità delle diverse materie prime necessarie per completare l'ordine di produzione, oltre a tutte le altre proprietà della distinta base restituite da OpenBOM a seconda di come è configurata la distinta base.

Endpoint e intestazioni

1. Una chiamata POST all'endpoint: https://developer-api.openbom.com:443/boms/byparams
2. Intestazione della richiesta x-openbom-appkey, x-openbom-accesstoken
3. Corpo della richiesta Content-Type:JSON , nome come chiave passata nel JSON

Input richiesti

1. Gettone di accesso
2. NOME BOM - Passato come valore alla chiave 'name' nel corpo della richiesta.

Uscite richieste

1. Righe restituite da OpenBOM per una specifica distinta base che include le proprietà dei diversi materiali che ne fanno parte.
2. Gli utenti possono analizzare i dettagli specifici restituiti da OpenBOM in base al caso d'uso.

Ottenere un catalogo specifico

Scopo

1. Oltre a varie altre proprietà predefinite o personalizzate, i cataloghi in OpenBOM mantengono l'inventario delle parti in mano che può essere utilizzato per visualizzare/aggiornare l'inventario in tempo reale all'interno di Tulip.
2. Questa funzione viene utilizzata per ottenere informazioni su tutte le proprietà disponibili nei Cataloghi di OpenBOM.

Punto finale e intestazioni

1. Una chiamata GET all'endpoint: https://developer-api.openbom.com:443/bom/{bomid}
2. Intestazione della richiesta x-openbom-appkey, x-openbom-accesstoken
3. Parametro URL: {catid} - Sarà passato come input.

Ingresso richiesto

1. Gettone di accesso
2. CATID: Per ottenere le informazioni sulla specifica distinta base di interesse.

Output richiesto

1. A seconda del caso d'uso, gli utenti possono estrarre diverse proprietà del catalogo restituite da OpenBOM, tra cui Quantity On Hand, che può essere utilizzata per gestire l'inventario in Tulip e aggiornarlo in tempo reale.

Aggiornamento delle proprietà del catalogo

Scopo

1. Il catalogo in OpenBOM mantiene l'inventario dei pezzi in mano che può essere utilizzato per visualizzare/aggiornare l'inventario in tempo reale di questi pezzi all'interno delle applicazioni Tulip in esecuzione in officina.
2. Questa funzione viene utilizzata per aggiornare le proprietà del catalogo in tempo reale, come ad esempio la Quantità a portata di mano, che evidenzia l'inventario dei materiali utilizzati per assemblare il prodotto in officina. Poiché i materiali vengono consumati in tempo reale, possiamo sfruttare questa funzione per aggiornare la Quantità in tempo reale mentre l'operatore procede all'assemblaggio di un'unità utilizzando l'app Istruzioni di lavoro di Tulip.

Endpoint e intestazioni

1. Una chiamata POST all'endpoint: https: //developer-api.openbom.com:443/catalog/{catid}/propertyvalue
2. Intestazione della richiesta x-openbom-appkey, x-openbom-accesstoken
3. Corpo della richiesta Tipo di contenuto : JSON
4. Sono necessarie 4 chiavi da passare in un JSON: partNumberPropertyName, partNumber, propertyName, propertyValue.

Input richiesto

1. Gettone di accesso
2. CATID: Parametro URL
3. PartNumberPropertyName: Valore per la chiave passata nel corpo della richiesta
4. Numero di parte: Valore per la chiave passata nel corpo della richiesta
5. NomeProprietà: Valore per la chiave passata nel corpo della richiesta
6. PropertyValue: Valore per la chiave passata nel corpo della richiesta

OpenBOM restituisce uno stato di 200 con una risposta di successo "Property Updated".

Video

Un piccolo video che spiega come utilizzare OpenBOM con un'applicazione Tulip.