OpenBOM-Anschluss

OpenBOM-Konnektor

Integrieren Sie Tulip mit OpenBOM unter Verwendung des HTTP-Connectors von Tulip

Einführung

OpenBOM ist eine Cloud-basierte Echtzeit-Zusammenarbeits- und Datenverwaltungstechnologie, die die Verwaltung von Teilen, Katalogen, Stücklisten, Beständen und Bestellungen in Netzwerken von Ingenieuren, Supply Chain Managern und Vertragsherstellern ermöglicht. Das Ziel dieses Konnektors ist die Integration von OpenBOM mit Tulip unter Verwendung der HTTP-Konnektoren von Tulip und die Bereitstellung eines sofort einsatzbereiten OpenBOM-Konnektors, der in Ihre Instanz importiert werden kann.

Zweck

1. Wir werden verschiedene HTTP-Connector-Funktionen hervorheben, die durch HTTP-Aufrufe an die Endpunkte von OpenBOM erstellt werden können, um Informationen über konfigurierte Stücklisten (BOMs), gepflegte Kataloge und Informationen über in OpenBOM freigegebene Produktionsauftrags-Stücklisten zu erhalten.
2. Tulip-Anwendungen können erstellt werden, um Arbeitsanweisungen für Bediener in der Werkstatt anzupassen, die Informationen über Produktionsaufträge abrufen und die Teile hervorheben, die die Bediener für die Montage von Produkten und die Fertigstellung des Produktionsauftrags in der Werkstatt benötigen. Durch die Nutzung von Katalogen in OpenBOMs werden wir zeigen, wie Manager in der Werkstatt ein Echtzeit-Inventar der verschiedenen Teile, die für die Montage des Produkts in der Werkstatt benötigt werden, verwalten können.

API-Dokument

Die folgenden, in diesem Dokument hervorgehobenen Konnektor-Funktionen haben die API Docs von OpenBOM genutzt

Vorraussetzungen

1. Erstellen Sie ein Konto bei OpenBOM und konfigurieren Sie OpenBOM-Kataloge und -Stücklisten für das Produkt, das in Ihrer Werkstatt zusammengebaut werden soll.
2. Sie müssen einen API-Schlüssel generieren, der in Tulip-Konnektoren verwendet wird, um Verbindungen mit OpenBOM herzustellen.
3. Mit Hilfe der Basisauthentifizierung (Benutzername und Passwort) erhalten Sie das Access Token (siehe unten), das als Request Header in allen Connector-Funktionen übergeben wird.

Tulip-Verbindungsdetails

Die folgenden Informationen müssen auf dem HTTP-Konnektor von Tulip konfiguriert werden.

1. Läuft auf: Cloud Connector Host
2. Rechner: developer-api.openbom.com
3. Anschluss:443
4. TLS: Ja
5. Authentifizierung: Keine Authentifizierung
6. Kopfzeilen: x-openbom-appkey

Konnektor-Funktionen

Zugriffstoken erhalten

Zweck

1. Abrufen des Zugriffstokens, der in allen nachfolgenden Connector-Funktionen als Anfragekopf verwendet wird.
2. Das Zugriffstoken läuft alle 24 Stunden ab. Nach der Ausführung dieser Konnektorfunktion gibt OpenBOM das Zugriffstoken zurück, das in einer Tulip-Variablen gespeichert werden kann, die von allen nachfolgenden Konnektorfunktionen dynamisch als Anfragekopf verwendet werden kann.

Endpunkt & Kopfzeilen

1. Ein POST-Aufruf an den Endpunkt: https://developer-api.openbom.com:443/login
2. Anfrage-Header: x-openbom-appkey
3. Request Body : ContentType: JSON Benutzername & Passwort als Schlüssel

Erforderlicher Output-Extraktor

1. Access Token - Das zurückgegebene Access Token wird in allen Sub-Connector-Funktionen verwendet.

Abrufen einer Liste von Katalogen

Zweck

1. Dieser Endpunkt liefert eine Liste der im OpenBOM-Profil des Benutzers verfügbaren Kataloge.
2. Die Liste kann verwendet werden, um die Katalog-IDs zu extrahieren, die verwendet werden können, um bestimmte Kataloge für das Abrufen des aktuellen Bestands für verschiedene Materialien und das Aktualisieren verschiedener Eigenschaften innerhalb des Katalogs in Echtzeit zu nutzen.

Endpunkt & Kopfzeilen

1. Ein GET-Aufruf an den Endpunkt: https://developer-api.openbom.com:443/catalogs
2. Anfrage-Header: x-openbom-appkey, x-openbom-accesstoken

Erforderliche Eingabe

1. Access Token, das durch eine Variable übergeben werden muss, die als Request Header für den HTTP-Aufruf an den oben genannten Endpunkt erforderlich ist.

Erforderliche Output-Extraktoren

1. CatalogId - Kann verwendet werden, um bestimmte Kataloge von Interesse aufzurufen

Abrufen einer Liste von BOMs

Zweck

1. Dieser Endpunkt liefert eine Liste der im OpenBOM-Profil des Benutzers verfügbaren Stücklisten.
2. Die Liste kann verwendet werden, um die Stücklisten-IDs oder die Namen der Stücklisten zu extrahieren, die verwendet werden können, um bestimmte Stücklisten für das Abrufen von Informationen über verschiedene Teile zu nutzen, die für die Montage einer Einheit in der Werkstatt benötigt werden.

Endpunkt und Kopfzeilen

1. Ein GET-Aufruf an den Endpunkt: https://developer-api.openbom.com:443/boms
2. Anfrage-Header x-openbom-appkey, x-openbom-accesstoken

Erforderliche Eingabe

1. Access Token, das von einer Variablen übergeben werden muss, die als Request Header für den HTTP-Aufruf an den oben genannten Endpunkt erforderlich ist.

Erforderliche Output-Extraktoren

1. BOMId - Kann verwendet werden, um bestimmte Stücklisten von Interesse aufzurufen.
2. Name - Kann verwendet werden, um eine POST zum Aufrufen einer bestimmten Stückliste durch Übergabe der Eigenschaft Name durchzuführen.

Produktionsauftragsstückliste abrufen

Zweck

1. Diese Funktion ruft die Produktionsauftragsstückliste ab, wenn die spezifische Stückliste für die Montage einer Einheit auf OpenBOM für die Produktion freigegeben wird.
2. Diese Konnektorfunktion extrahiert wichtige Details (Name, BOMID, Anzahl der Einheiten) über den Produktionsauftrag, die dynamisch übergeben werden, um eine bestimmte Stücklisten-ID aufzurufen, die alle Informationen über die Gesamtzahl der Teile enthält, die der Bediener für die Fertigstellung des gesamten Produktionsauftrags benötigt.

Endpunkt & Kopfzeilen

1. Ein GET-Aufruf an den Endpunkt: https://developer-api.openbom.com:443/orderboms
2. Anfrage-Header: x-openbom-appkey, x-openbom-accesstoken

Erforderliche Eingabe

1. Access Token, das von einer Variablen übergeben werden muss, die als Request Header für den HTTP-Aufruf an den oben genannten Endpunkt erforderlich ist.

Erforderliche Ausgabe-Extraktoren

1. Name - Dies kann verwendet werden, um die Details für eine bestimmte Produktionsstückliste zu erhalten, indem der Name an den stücklistenspezifischen Endpunkt übergeben wird.
2. BOMID - Diese Eigenschaft wird verwendet, um alle Details für eine bestimmte Produktionsstückliste zu erhalten, indem die ID an den stücklistenspezifischen Endpunkt übergeben wird.
3. numUnits - Diese Eigenschaft kann verwendet werden, um die Anzahl der Einheiten anzugeben, die in der Werkstatt für einen einzelnen Produktionsauftrag hergestellt werden sollen.

Spezifische Stückliste abrufen

Zweck

1. Diese Funktion ruft die Eigenschaften für alle verschiedenen Materialien ab, die in einer bestimmten Stückliste für die Montage einer Einheit enthalten sind.
2. Die von OpenBOM zurückgegebenen Zeilen können in Tulip geparst werden, um die Menge der verschiedenen Rohmaterialien anzuzeigen, die für die Fertigstellung des Produktionsauftrags benötigt werden, zusätzlich zu allen anderen von OpenBOM zurückgegebenen Stücklisteneigenschaften, je nachdem, wie die Stückliste konfiguriert ist.

Endpunkt & Kopfzeilen

1. Ein GET-Aufruf an den Endpunkt: https: //developer-api.openbom.com:443/bom/{bomid}
2. Anfrage-Header: x-openbom-appkey, x-openbom-accesstoken
3. URL-Parameter: {bomid} - Dieser wird als Eingabe übergeben.

Erforderliche Eingaben

1. Access Token, das von einer Variablen übergeben wird, die als Request Header für den HTTP-Aufruf an den oben genannten Endpunkt erforderlich ist.
2. BOMID - Zum Abrufen der Informationen über die spezifische Stückliste von Interesse.

Erforderliche Ausgaben

1. Von OpenBOM zurückgegebene Zeilen für eine bestimmte Stückliste, die die Eigenschaften für verschiedene Materialien enthalten, die Teil der Stückliste sind
2. Die Benutzer können die von OpenBOM zurückgegebenen spezifischen Details je nach Anwendungsfall analysieren.

Bestimmte Stückliste nach Name abrufen

Zweck

1. Diese Funktion ruft die Eigenschaften für alle verschiedenen Materialien ab, die in einer bestimmten Stückliste enthalten sind, um eine Einheit zusammenzustellen, indem der Name der Stückliste anstelle einer ID übergeben wird.
2. Die von OpenBOM zurückgegebenen Zeilen können in Tulip geparst werden, um die Menge der verschiedenen Rohmaterialien anzuzeigen, die für die Fertigstellung des Produktionsauftrags benötigt werden, zusätzlich zu allen anderen von OpenBOM zurückgegebenen Stücklisteneigenschaften, je nachdem, wie die Stückliste konfiguriert ist.

Endpunkt & Kopfzeilen

1. Ein POST-Aufruf an den Endpunkt: https://developer-api.openbom.com:443/boms/byparams
2. Anfrage-Header x-openbom-appkey, x-openbom-accesstoken
3. Request Body Content-Type:JSON , Name als der im JSON übergebene Schlüssel

Erforderliche Eingaben

1. Zugriffstoken
2. BOM NAME - Übergeben als Wert für den Schlüssel "name" im Anfragekörper.

Erforderliche Ausgaben

1. Von OpenBOM zurückgegebene Zeilen für eine bestimmte Stückliste, die die Eigenschaften für verschiedene Materialien enthalten, die Teil der Stückliste sind
2. Benutzer können je nach Anwendungsfall bestimmte von OpenBOM zurückgegebene Details analysieren.

Spezifischen Katalog abrufen

Zweck

1. Zusätzlich zu verschiedenen anderen vordefinierten oder benutzerdefinierten Eigenschaften verwaltet der Katalog in OpenBOM den Bestand der vorhandenen Teile, der zur Anzeige/Aktualisierung des Echtzeitbestands in Tulip verwendet werden kann
2. Mit dieser Funktion erhalten Sie Informationen über alle in OpenBOMs Catalogs verfügbaren Eigenschaften.

Endpunkt & Kopfzeilen

1. Ein GET-Aufruf an den Endpunkt: https://developer-api.openbom.com:443/bom/{bomid}
2. Anfrage-Header x-openbom-appkey, x-openbom-accesstoken
3. URL-Parameter : {catid} - Dieser wird als Input übergeben.

Erforderliche Eingabe

1. Zugriffstoken
2. CATID: Zum Abrufen der Informationen über die spezifische Stückliste von Interesse.

Erforderliche Ausgabe

1. Je nach Anwendungsfall können die Benutzer verschiedene Katalogeigenschaften extrahieren, die von OpenBOM zurückgegeben werden, wobei die Bestandsmenge eine Eigenschaft ist, die für die Verwaltung des Inventars in Tulip und die Aktualisierung in Echtzeit verwendet werden kann.

Aktualisierung der Katalogeigenschaften

Zweck

1. Der Katalog in OpenBOM verwaltet das Inventar der vorhandenen Teile, das zur Anzeige/Aktualisierung des Echtzeit-Inventars dieser Teile in den Tulip-Anwendungen, die in der Werkstatt laufen, verwendet werden kann.
2. Diese Funktion wird verwendet, um die Eigenschaften im Katalog in Echtzeit zu aktualisieren. Ein Beispiel dafür ist der Bestand an Materialien, die für den Zusammenbau des Produkts in der Werkstatt verwendet werden. Da die Materialien in Echtzeit verbraucht werden, können wir diese Funktion nutzen, um die Menge in Echtzeit zu aktualisieren, während der Bediener mit dem Zusammenbau einer Einheit mit Hilfe der Arbeitsanweisungs-App in Tulip fortfährt.

Endpunkt & Kopfzeilen

1. Ein POST-Aufruf zum Endpunkt: https: //developer-api.openbom.com:443/catalog/{catid}/propertyvalue
2. Anfrage-Header x-openbom-appkey, x-openbom-accesstoken
3. Request Body Inhaltstyp : JSON
4. 4 Schlüssel müssen in einem JSON übergeben werden - partNumberPropertyName, partNumber, propertyName, propertyValue

Erforderliche Eingabe

1. Zugriffs-Token
2. CATID: URL-Parameter
3. TeilNummerEigenschaftsName: Wert für den im Request Body übergebenen Schlüssel
4. TeilNummer: Wert für den im Request Body übergebenen Schlüssel
5. Eigenschaftsname: Wert für den im Request Body übergebenen Schlüssel
6. EigenschaftWert: Wert für den im Request Body übergebenen Schlüssel

OpenBOM gibt bei einer erfolgreichen "Property Updated"-Antwort einen Status von 200 zurück.

Video

Ein kleines Video, das erklärt, wie Sie OpenBOM mit einer Tulip App verwenden können.