- Nyomtat
OpenBOM csatlakozó
A Tulip és az OpenBOM integrálása a Tulip HTTP Connector segítségével
Bevezetés
Az OpenBOM egy felhőalapú, valós idejű együttműködési és adatkezelési technológia, amely lehetővé teszi az alkatrészek, katalógusok, anyagjegyzékek, készletek és beszerzési megrendelések kezelését mérnökök, ellátási lánc menedzserek és szerződéses gyártók hálózatán keresztül. Ennek a csatlakozónak az a célja, hogy az OpenBOM-ot a Tulip HTTP csatlakozók segítségével integrálja a Tulip Tulipba, és egy olyan OpenBOM csatlakozót biztosítson, amelyet importálhat az Ön példányába.
Cél
- Különböző HTTP-csatlakozó funkciókat fogunk kiemelni, amelyeket az OpenBOM végpontjaihoz intézett HTTP-hívásokkal lehet létrehozni, hogy információkat kapjunk a konfigurált anyagjegyzékekről (BOM), a karbantartott katalógusokról és az OpenBOM-ban kiadott gyártási megrendelések BOM-jairól.
- Tulip alkalmazások építhetők az üzemi területen dolgozó operátorok munkautasításainak testreszabására, amelyek a gyártási megrendelésekre vonatkozó információkat hívják le, kiemelve az operátorok számára a termékek összeszereléséhez és a gyártási megrendelés befejezéséhez szükséges alkatrészeket az üzemi területen. Az OpenBOM-ban található katalógusok felhasználásával bemutatjuk, hogy az üzemi vezetők hogyan tarthatnak valós idejű leltárt a különböző alkatrészekről, amelyek a termék összeszereléséhez szükségesek az üzemi szinten.
API dokumentum
A következő, ebben a dokumentumban kiemelt csatlakozófunkciók az OpenBOM API Docs felhasználásával készültek.
Előfeltételek
- Hozzon létre egy fiókot az OpenBOM-on, és konfigurálja az OpenBOM katalógusokat és BOM-okat az Ön üzemi szintjén összeszerelendő termékhez.
- Létre kell hoznia egy API-kulcsot, amelyet a Tulip csatlakozók használnak az OpenBOM-mal való kapcsolat létrehozásához.
- Alapvető hitelesítéssel (felhasználónév és jelszó) szerezze meg az Access Token-t (lásd alább), amelyet kérésfejlécként kell átadni az összes csatlakozófunkcióban.
Tulip kapcsolat részletei
A következő információkat kell beállítani a Tulip HTTP-csatlakozóján.
- Futtatás: Cloud Connector Host
- Host: developer-api.openbom.com
- Port:443
- TLS: Igen
- Hitelesítés: Auth: Nem
- Fejlécek: x-openbom-appkey
Csatlakozó funkciók
Hozzáférési token megszerzése
Cél
- A hozzáférési token megszerzése, amelyet kérésfejlécként használnak az összes későbbi csatlakozófüggvényben.
- Az Access Token 24 óránként lejár. A csatlakozófüggvény futtatása után az OpenBOM visszaadja a hozzáférési tokent, amely egy Tulip változóban tárolható, és amelyet az összes későbbi csatlakozófüggvény dinamikusan használhat kérésfejlécként.
Végpont és fejlécek
- A POST hívás a végponthoz: https://developer-api.openbom.com:443/login
- Kérelem fejléc: x-openbom-appkey
- Kérelem teste : ContentType: JSON felhasználónév és jelszó mint kulcsok
Szükséges kimeneti kivonat
- Access Token - A visszaküldött Access Token az összes alcsatlakozó funkcióban használatos.
Katalógusok listájának lekérdezése
Cél
- Ez a végpont a felhasználó OpenBOM profiljában elérhető katalógusok listáját adja.
- A lista felhasználható a katalógusazonosítók kinyerésére, amelyek felhasználhatók a különböző anyagok aktuális leltárának lehívására és a katalóguson belüli különböző tulajdonságok valós idejű frissítésére.
Végpont és fejlécek
- A GET hívás a végponthoz: https://developer-api.openbom.com:443/catalogs
- Kérelem fejlécek: x-openbom-appkey, x-openbom-accesstoken
Kötelező bemenet
- Access Token, amelyet egy változóval kell átadni, amely a fenti végpont HTTP-hívásához szükséges kérési fejlécként a fenti végponthoz.
Kötelező kimeneti kivonatolók
- CatalogId - Az adott katalógusok meghívására használható.
A BOM-ok listájának lekérdezése
Cél
- Ez a végpont a felhasználó OpenBOM-profiljában elérhető BOM-ok listáját adja meg.
- A lista felhasználható a BOM azonosítók vagy a BOM-ok nevének kinyerésére, amelyek felhasználhatók bizonyos BOM-ok felhasználására a különböző alkatrészekre vonatkozó információk kinyeréséhez, amelyek szükségesek az egység összeszereléséhez a gyártóüzemben.
Végpont és fejlécek
- A GET hívás a végponthoz: https://developer-api.openbom.com:443/boms
- Kérés fejlécek x-openbom-appkey, x-openbom-accesstoken
Kötelező bemenet
- A fenti végpont HTTP-hívásához kérési fejlécként szükséges, változóval átadandó hozzáférési token.
Kötelező kimeneti kivonatolók
- BOMId - Használható az adott BOM-ok meghívására.
- Name - A Name tulajdonság átadásával egy adott BOM meghívására irányuló POST megküldésére használható.
Gyártási rendelés darabjegyzékének beszerzése
Cél
- Ez a funkció akkor hívja le a gyártási rendelés darabjegyzékét, amikor az egység összeszereléséhez szükséges konkrét darabjegyzéket az OpenBOM-on kiadják a gyártáshoz.
- Ez a csatlakozófüggvény fontos adatokat (név, BOMID, darabszám) nyer ki a gyártási megrendelésről, amelyeket dinamikusan át kell adni egy adott BOM azonosító meghívásához, amely tartalmazza az összes információt a teljes gyártási megrendelés teljesítéséhez szükséges alkatrészek teljes számáról.
Végpont és fejlécek
- A GET-hívás a következő végpontra: https://developer-api.openbom.com:443/orderboms.
- Kérelem fejlécek: x-openbom-appkey, x-openbom-accesstoken
Kötelező bemenet
- Access Token, amelyet egy változóval kell átadni, amely a fenti végpont HTTP-hívásához szükséges kérési fejlécként a fenti végponthoz.
Kötelező kimeneti kivonatolók
- Név - Ez egy adott gyártási darabjegyzék részleteinek lekérdezésére használható a névnek a darabjegyzék-specifikus végponthoz történő átadásával.
- BOMID - Ez egy adott gyártási darabszám összes részletének lekérdezésére használható az azonosítónak a darabszámspecifikus végponthoz történő átadásával.
- numUnits - Ez a tulajdonság használható az üzemben legyártandó egységek számának megadására egyetlen gyártási megrendeléshez.
Speciális darabjegyzék beszerzése
Cél
- Ez a funkció lekérdezi az egység összeállításához egy adott BOM-ban szereplő összes különböző anyag tulajdonságait.
- Az OpenBOM által visszaküldött sorok elemezhetők a Tulipba, amely a gyártási megrendelés befejezéséhez szükséges különböző nyersanyagok mennyiségének megjelenítésére használható az OpenBOM által visszaküldött összes többi BOM tulajdonságon kívül, attól függően, hogy a BOM hogyan van konfigurálva.
Végpont és fejlécek
- A GET hívás a végpontra : https://developer-api.openbom.com:443/bom/{bomid}
- Kérelem fejléc: x-openbom-appkey, x-openbom-accesstoken
- URL paraméter : {bomid} - Ezt a paramétert bemenetként kell átadni.
Kötelező bemenetek
- Access Token, amelyet egy változóval kell átadni, amely a fenti végpont HTTP-hívásához szükséges kérési fejlécként a fenti végponthoz.
- BOMID - Az adott, érdeklődésre számot tartó BOM-ra vonatkozó információk lekérdezése.
Kötelező kimenetek
- Az OpenBOM által egy adott darabjegyzékhez visszaküldött sorok, amelyek tartalmazzák a darabjegyzék részét képező különböző anyagok tulajdonságait.
- A felhasználók az OpenBOM által visszaküldött konkrét részleteket a felhasználási eset alapján elemezhetik.
Konkrét BOM beszerzése név alapján
Cél
- Ez a funkció az egység összeállításához egy adott BOM-ban szereplő összes különböző anyag tulajdonságait kapja meg a BOM neve átadásával az azonosító helyett.
- Az OpenBOM által visszaküldött sorok elemezhetők Tulipba, amely a gyártási megrendelés befejezéséhez szükséges különböző nyersanyagok mennyiségének megjelenítésére használható az OpenBOM által visszaküldött összes többi BOM tulajdonságon kívül, attól függően, hogy a BOM hogyan van konfigurálva.
Végpont és fejlécek
- A POST hívás a végponthoz: https://developer-api.openbom.com:443/boms/byparams
- Kérelem fejléc x-openbom-appkey, x-openbom-accesstoken
- Request Body Content-Type:JSON , name mint a JSON-ban átadott kulcs.
Kötelező bemenetek
- Hozzáférési token
- BOM NAME - A kérés testében a "name" kulcs értékeként átadott érték.
Kötelező kimenetek
- Az OpenBOM által egy adott BOM-ra visszaküldött sorok, amelyek tartalmazzák a BOM részét képező különböző anyagok tulajdonságait.
- A felhasználók az OpenBOM által visszaküldött konkrét részleteket a felhasználási eset alapján elemezhetik.
Speciális katalógus beszerzése
Cél
- A különböző egyéb előre meghatározott vagy testreszabott tulajdonságok mellett az OpenBOM-ban lévő katalógusok fenntartják a kézben lévő alkatrészek leltárát, amelyek felhasználhatók a Tulipen belüli valós idejű leltár megjelenítésére/frissítésére.
- Ez a funkció az OpenBOMs Catalogs-ban elérhető összes tulajdonságra vonatkozó információk lekérdezésére szolgál.
Végpont és fejlécek
- A GET hívás a következő végpontra: https://developer-api.openbom.com:443/bom/{bomid}
- Kérelem fejléc x-openbom-appkey, x-openbom-accesstoken
- URL paraméter : {catid} - Ezt a paramétert Inputként kell átadni.
Kötelező bemenet
- Hozzáférési jelszó
- CATID: Az adott BOM-ra vonatkozó információk lekérdezése.
Kötelező kimenet
- A felhasználási esettől függően a felhasználók az OpenBOM által visszaküldött különböző katalógus-tulajdonságokat kivonatolhatják, a Készleten lévő mennyiség az egyik tulajdonság, amelyet a Tulip leltárkezeléséhez és a valós idejű frissítéshez lehet használni.
Katalógus tulajdonságok frissítése
Cél
- Az OpenBOM katalógusában a kézben lévő alkatrészek leltárát tárolja, amely felhasználható az alkatrészek valós idejű leltárának megjelenítésére/frissítésére az üzemi területen futó Tulip alkalmazásokban.
- Ez a funkció a Katalógus tulajdonságainak valós idejű frissítésére szolgál, például a Kéznél lévő mennyiséggel, amely kiemeli a termék összeszereléséhez használt anyagok készletét az üzletben. Mivel az anyagok valós időben fogynak, kihasználhatjuk ezt a funkciót a Mennyiség valós idejű frissítésére, ahogy a kezelő a Tulip munkautasításos alkalmazásával folytatja az egység összeszerelését.
Végpont és fejlécek
- A POST hívás a végpontra : https://developer-api.openbom.com:443/catalog/{catid}/propertyvalue
- Kérelem fejléc x-openbom-appkey, x-openbom-accesstoken
- Request Body Tartalom típusa : JSON
- 4 kulcsot kell átadni a JSON-ban -partNumberPropertyName, partNumber, propertyName, propertyValue
Kötelező bemenet
- Hozzáférési jelszó
- CATID: URL paraméter
- PartNumberPropertyName: A kérelem testében átadott kulcs értéke
- PartNumber: A kérelem testében átadott kulcs értéke
- PropertyName: A kérelem testében átadott kulcs értéke
- PropertyValue: A kérelem testében átadott kulcs értéke
Az OpenBOM 200-as státuszt küld vissza a sikeres "Property Updated" válasz esetén.
Videó
Egy kis videó, amely elmagyarázza, hogyan használhatja az OpenBOM-ot egy Tulip alkalmazással.