OpenBOM 커넥터

OpenBOM 커넥터

Tulip의 HTTP 커넥터를 사용하여 Tulip과 OpenBOM 통합하기

소개

OpenBOM은 클라우드 기반의 실시간 협업 및 데이터 관리 기술로, 엔지니어, 공급망 관리자, 계약 제조업체의 네트워크에서 부품, 카탈로그, 자재 명세서, 재고 및 구매 주문을 관리할 수 있습니다. 이 커넥터의 목표는 Tulip의 HTTP 커넥터를 사용하여 OpenBOM을 Tulip과 통합하고 인스턴스로 가져올 수 있는 즉시 사용 가능한 OpenBOM 커넥터를 제공하는 것입니다.

목적

1. OpenBOM의 엔드포인트에 HTTP 호출을 수행하여 구성한 BOM(Bill of Materials) 정보, 유지 관리되는 카탈로그 및 OpenBOM에서 릴리스된 생산 주문 BOM에 대한 정보를 가져오는 다양한 HTTP 커넥터 기능을 중점적으로 살펴보고자 합니다.
2. 작업자가 작업 현장에서 제품을 조립하고 생산 주문을 완료하는 데 필요한 부품을 강조하는 생산 주문에 대한 정보를 가져오는 작업 지침을 사용자 지정하도록 Tulip 앱을 구축할 수 있습니다. OpenBOM의 카탈로그를 활용하여 작업 현장 관리자가 작업 현장에서 제품을 조립하는 데 필요한 다양한 부품의 실시간 재고를 유지하는 방법을 소개합니다.

API 문서

이 문서에서 강조 표시된 다음 커넥터 기능은 OpenBOM의 API 문서를 활용했습니다.

사전 요구 사항

1. 작업 현장에서 조립할 제품에 대해 OpenBOM에 계정을 생성하고 OpenBOM 카탈로그 및 BOM을 구성합니다.
2. OpenBOM과 연결하기 위해 Tulip 커넥터에서 사용되는 API 키를 생성해야 합니다.
3. 기본 인증(사용자 이름 및 비밀번호)을 사용하여 모든 커넥터 기능에서 요청 헤더로 전달되는 액세스 토큰(아래 설명)을 얻습니다.

튤립 연결 세부 정보

Tulip의 HTTP 커넥터에 다음 정보를 구성해야 합니다.

1. 실행 대상: 클라우드 커넥터 호스트
2. 호스트: developer-api.openbom.com
3. 포트: 443
4. TLS: 예
5. 인증: 인증: 아니요 인증
6. 헤더: x-openbom-appkey

커넥터 기능

액세스 토큰 가져오기

목적

1. 이후의 모든 커넥터 함수에서 요청 헤더로 사용될 액세스 토큰을 가져옵니다.
2. 액세스 토큰은 24시간마다 만료됩니다. 이 커넥터 함수를 실행하면 OpenBOM은 이후의 모든 커넥터 함수에서 요청 헤더로 동적으로 사용할 수 있는 액세스 토큰을 Tulip 변수에 저장할 수 있는 액세스 토큰을 반환합니다.

엔드포인트 및 헤더

1. 엔드포인트에 대한 POST 호출: https://developer-api.openbom.com:443/login
2. 요청 헤더: x-openbom-appkey
3. 요청 본문: ContentType: 키로서의 JSON 사용자 이름 및 비밀번호

필수 출력 추출기

1. 액세스 토큰 - 반환된 액세스 토큰은 모든 하위 커넥터 함수에서 사용됩니다.

카탈로그 목록 가져오기

목적

1. 이 엔드포인트는 사용자의 OpenBOM 프로필에서 사용 가능한 카탈로그 목록을 제공합니다.
2. 이 목록은 다양한 재료에 대한 현재 인벤토리를 가져오고 카탈로그 내의 다양한 속성을 실시간으로 업데이트하기 위해 특정 카탈로그를 활용하는 데 사용할 수 있는 카탈로그 ID를 추출하는 데 사용할 수 있습니다.

엔드포인트 및 헤더

1. 엔드포인트에 대한 GET 호출: https://developer-api.openbom.com:443/catalogs
2. 요청 헤더: x-오픈봄-앱키, x-오픈봄-액세스토큰

필수 입력

1. 위 엔드포인트에 대한 HTTP 호출의 요청 헤더로 필요한 변수로 전달할 액세스 토큰입니다.

필수 출력 추출기

1. CatalogId - 관심 있는 특정 카탈로그를 호출하는 데 사용할 수 있습니다.

BOM 목록 가져오기

목적

1. 이 엔드포인트는 사용자의 OpenBOM 프로필에서 사용 가능한 BOM 목록을 제공합니다.
2. 이 목록은 작업 현장에서 유닛의 조립을 완료하는 데 필요한 다양한 부품에 대한 정보를 가져오는 데 사용할 수 있는 특정 BOM을 활용하는 데 사용할 수 있는 BOM ID 또는 BOM의 이름을 추출하는 데 사용할 수 있습니다.

엔드포인트 및 헤더

1. 엔드포인트에 대한 GET 호출: https://developer-api.openbom.com:443/boms
2. 요청 헤더 x-오픈봄-앱키, x-오픈봄-액세스토큰

필수 입력

1. 위 엔드포인트에 대한 HTTP 호출의 요청 헤더로 필요한 변수로 전달할 액세스 토큰입니다.

필수 출력 추출기

1. BOMId - 관심 있는 특정 BOM을 호출하는 데 사용할 수 있습니다.
2. Name - Name 속성을 전달하여 특정 BOM을 호출하는 POST를 수행하는 데 사용할 수 있습니다.

생산 주문 BOM 가져오기

목적

1. 이 함수는 장치 조립을 위한 특정 BOM이 OpenBOM에서 생산에 릴리스될 때 생산 주문 BOM을 가져옵니다.
2. 이 커넥터 함수는 작업자가 전체 생산 주문을 완료하는 데 필요한 총 부품 수에 대한 모든 정보가 포함된 특정 BOM ID를 호출하기 위해 동적으로 전달되는 생산 주문에 대한 중요한 세부 정보(이름, BOMID, 단위 수)를 추출합니다.

엔드포인트 및 헤더

1. 엔드포인트에 대한 GET 호출: https://developer-api.openbom.com:443/orderboms
2. 요청 헤더: x-오픈봄-앱키, x-오픈봄-액세스토큰

필수 입력

1. 위 엔드포인트에 대한 HTTP 호출의 요청 헤더로 필요한 변수로 전달할 액세스 토큰입니다.

필수 출력 추출기

1. 이름 - BOM 특정 엔드포인트에 이름을 전달하여 특정 프로덕션 BOM에 대한 세부 정보를 가져오는 데 사용할 수 있습니다.
2. BOMID - BOM 특정 엔드포인트에 ID를 전달하여 특정 생산 BOM에 대한 모든 세부 정보를 가져오는 데 사용됩니다.
3. numUnits - 이 속성은 단일 생산 주문에 대해 작업 현장에서 생산할 단위 수를 나타내는 데 사용할 수 있습니다.

특정 BOM 가져오기

목적

1. 이 함수는 특정 BOM에 포함된 모든 다른 자재에 대한 속성을 가져와 유닛을 조립합니다.
2. OpenBOM에서 반환된 행을 Tulip으로 파싱하여 BOM 구성 방식에 따라 OpenBOM에서 반환된 다른 모든 BOM 속성 외에 생산 주문을 완료하는 데 필요한 다양한 원자재의 수량을 표시하는 데 사용할 수 있습니다.

엔드포인트 및 헤더

1. 엔드포인트에 대한 GET 호출: https: //developer-api.openbom.com:443/bom/{bomid}
2. 요청 헤더: x-openbom-appkey, x-openbom-accesstoken
3. URL 파라미터 : {bomid} - 입력으로 전달됩니다.

필수 입력

1. 위 엔드포인트에 대한 HTTP 호출의 요청 헤더로 필요한 변수로 전달할 액세스 토큰입니다.
2. BOMID - 관심 있는 특정 BOM에 대한 정보를 가져옵니다.

필수 출력

1. BOM의 일부인 다양한 자재에 대한 속성을 포함하는 특정 BOM에 대해 OpenBOM이 반환하는 행입니다.
2. 사용자는 사용 사례에 따라 OpenBOM에서 반환된 특정 세부 정보를 파싱할 수 있습니다.

이름으로 특정 BOM 가져오기

목적

1. 이 함수는 특정 BOM에 포함된 모든 다른 자재에 대한 속성을 가져와서 ID 대신 BOM 이름을 전달하여 유닛을 조립합니다.
2. OpenBOM에서 반환된 행은 BOM 구성 방식에 따라 OpenBOM에서 반환된 다른 모든 BOM 속성 외에 생산 주문을 완료하는 데 필요한 다양한 원자재의 수량을 표시하는 데 사용되는 Tulip으로 구문 분석할 수 있습니다.

엔드포인트 및 헤더

1. 엔드포인트에 대한 POST 호출: https://developer-api.openbom.com:443/boms/byparams
2. 요청 헤더 x-오픈봄-앱키, x-오픈봄-액세스토큰
3. 요청 본문 콘텐츠 유형: JSON , JSON에 전달된 키의 이름

필수 입력

1. 액세스 토큰
2. BOM 이름 - 요청 본문에서 '이름' 키의 값으로 전달됩니다.

필수 출력

1. BOM의 일부인 다양한 자재에 대한 속성을 포함하는 특정 BOM에 대해 OpenBOM이 반환하는 행입니다.
2. 사용자는 사용 사례에 따라 OpenBOM이 반환한 특정 세부 정보를 파싱할 수 있습니다.

특정 카탈로그 가져오기

목적

1. 사전 정의되거나 사용자 정의된 다양한 기타 속성 외에도 OpenBOM의 카탈로그는 보유 중인 부품의 인벤토리를 유지 관리하여 Tulip 내에서 실시간 재고를 표시/업데이트하는 데 사용할 수 있습니다.
2. 이 기능은 OpenBOM 카탈로그에서 사용 가능한 모든 속성에 대한 정보를 가져오는 데 사용됩니다.

엔드포인트 및 헤더

1. 엔드포인트에 대한 GET 호출: https://developer-api.openbom.com:443/bom/{bomid}
2. 요청 헤더 x-오픈봄-앱키, x-오픈봄-액세스토큰
3. URL 매개변수 : {catid} - 입력으로 전달됩니다.

필수 입력

1. 액세스 토큰
2. CATID: 관심 있는 특정 BOM에 대한 정보를 가져옵니다.

필수 출력

1. 사용 사례에 따라 사용자는 OpenBOM에서 반환되는 다양한 카탈로그 속성을 추출할 수 있으며, 보유 수량은 Tulip에서 재고를 관리하고 실시간으로 업데이트하는 데 사용할 수 있는 하나의 속성입니다.

카탈로그 속성 업데이트

목적

1. OpenBOM의 카탈로그는 작업 현장에서 실행 중인 Tulip 앱 내에서 이러한 부품의 실시간 재고를 표시/업데이트하는 데 사용할 수 있는 보유 부품의 재고를 유지 관리합니다.
2. 이 기능은 카탈로그의 속성을 실시간으로 업데이트하는 데 사용되며, 보유 수량은 작업 현장에서 제품을 조립하는 데 사용되는 자재 재고를 강조 표시하는 한 가지 예입니다. 자재가 실시간으로 소비되고 있으므로 이 기능을 활용하여 작업자가 Tulip의 작업 지침 앱을 사용하여 유닛 조립을 진행하면서 수량을 실시간으로 업데이트할 수 있습니다.

엔드포인트 및 헤더

1. 엔드포인트에 대한 POST 호출: https: //developer-api.openbom.com:443/catalog/{catid}/propertyvalue
2. 요청 헤더 x-오픈밤-앱키, x-오픈밤-액세스토큰
3. 요청 본문 콘텐츠 유형 : JSON
4. 4개의 키가 JSON으로 전달되어야 합니다 -partNumberPropertyName, partNumber, propertyName, propertyValue

필수 입력

1. 액세스 토큰
2. CATID: URL 매개변수
3. 파트번호프로퍼티명: 요청 본문에 전달된 키의 값
4. PartNumber: 요청 본문에 전달된 키의 값
5. PropertyName: 요청 본문에 전달된 키의 값
6. PropertyValue: 요청 본문에 전달된 키의 값

OpenBOM은 성공적인 "속성 업데이트" 응답과 함께 200의 상태를 반환합니다.

동영상

Tulip 앱에서 OpenBOM을 사용하는 방법을 설명하는 짧은 동영상입니다.