OpenBOM 连接器

OpenBOM 连接器

使用 Tulip 的 HTTP 连接器集成 Tulip 和 OpenBOM

简介

OpenBOM是一种基于云的实时协作和数据管理技术，可跨工程师、供应链经理和合同制造商网络管理零件、目录、物料清单、库存和采购订单。本连接器的目标是使用 Tulip 的 HTTP连接器将 OpenBOM 与 Tulip 集成，并为您提供一个开箱即用的 OpenBOM 连接器，可以导入到您的实例中。

目的

1. 我们将重点介绍不同的 HTTP 连接器功能，这些功能可以通过 HTTP 调用 OpenBOM 的端点来获取配置的物料清单 (BOM) 信息、维护的目录以及获取 OpenBOM 中发布的生产订单 BOM 信息。
2. 可以构建 Tulip 应用程序，为车间操作员定制工作指导，提取生产订单信息，突出显示操作员在车间组装产品和完成生产订单所需的零部件。利用 OpenBOMs 中的目录，我们将展示车间管理人员如何维护车间装配产品所需的不同零件的实时库存。

应用程序接口文件

本文档中强调的以下连接器功能均利用了 OpenBOM 的API 文档

前提条件

1. 在 OpenBOM 上创建一个账户，并为要在车间组装的产品配置 OpenBOM 目录和 BOM。
2. 您需要生成一个 API 密钥，用于 Tulip 连接器与 OpenBOM 建立连接。
3. 使用基本身份验证（用户名和密码），获取访问令牌（解释如下），该令牌将作为请求头传递给所有连接器功能。

郁金香连接细节

需要在 Tulip 的 HTTP 连接器上配置以下信息。

1. 运行于：云连接器主机
2. 主机：developer-api.openbom.com
3. 端口：443
4. TLS: 是
5. 验证：无 Auth
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-openbom-appkey、x-openbom-accesstoken

所需输入

1. 访问令牌，由变量传递，作为 HTTP 调用上述端点时所需的请求标头。

所需输出提取器

1. 目录 ID - 可用于调用感兴趣的特定目录

获取 BOM 列表

目的

1. 该端点提供用户 OpenBOM 配置文件中可用的 BOM 列表。
2. 该列表可用于提取 BOM ID 或 BOM 名称，这些 BOM ID 或名称可用于调用特定 BOM，以获取在车间完成单元装配所需的不同零件的信息。

端点和标头

1. 对端点的 GET 调用**： https://developer-api.openbom.com:443/boms**
2. 请求标头x-openbom-appkey,x-openbom-accesstoken

所需输入

1. 由变量传递的访问令牌，作为 HTTP 调用上述端点时所需的请求标头。

所需的输出提取器

1. BOMId - 可用于调用感兴趣的特定 BOM
2. 名称 - 通过传递名称属性，可用于通过 POST 调用特定的 BOM。

获取生产订单 BOM

目的

1. 当用于组装一个单元的特定 BOM 在 OpenBOM 上发布到生产时，该函数将提取生产订单 BOM。
2. 该连接器函数提取有关生产订单的重要详细信息（名称、BOMID、单位数量），这些信息将动态传递给特定的 BOM ID，该 BOM ID 将包含操作员完成整个生产订单所需的零件总数的所有信息。

端点和标头

1. 对端点的 GET 调用**： https://developer-api.openbom.com:443/orderboms**
2. 请求标头：x-openbom-appkey、x-openbom-accesstoken

所需输入

1. 访问令牌，由变量传递，作为 HTTP 调用上述端点时所需的请求标头。

所需输出提取器

1. 名称（Name）- 通过将名称传递给特定 BOM 端点，可用于获取特定生产 BOM 的详细信息。
2. BOMID - 将 ID 传递给 BOM 特定端点，用于获取特定生产 BOM 的所有详细信息。
3. numUnits - 该属性可用于指示车间生产单个生产订单的单位数量。

获取特定 BOM

目的

1. 该函数获取特定 BOM 中所有不同材料的属性，以组装一个单元。
2. 除了 OpenBOM 返回的所有其他 BOM 属性（取决于 BOM 的配置方式）外，OpenBOM 返回的行还可被解析到 Tulip 中，用于显示完成生产订单所需的不同原材料的数量。

端点和标头

1. 对端点的 GET 调用：https://developer-api.openbom.com:443/bom/{bomid}
2. 请求头：x-openbom-appkey,x-openbom-accesstoken
3. URL 参数：{bomid}- 将作为输入传递。

所需输入

1. 访问令牌（Access Token）：通过变量传递，作为 HTTP 调用上述端点的请求标头。
2. BOMID - 获取相关特定 BOM 的信息。

所需输出

1. OpenBOM 为特定 BOM 返回的行，其中包括 BOM 中不同材料的属性。
2. 用户可根据用例解析 OpenBOM 返回的具体细节。

按名称获取特定 BOM

用途

1. 该函数通过传递 BOM 名称（而不是 id）来获取特定 BOM 中所有不同材料的属性，以组装一个单元。
2. 除了 OpenBOM 返回的所有其他 BOM 属性（取决于 BOM 的配置方式）外，OpenBOM 返回的行可被解析为 Tulip，用于显示完成生产订单所需的不同原材料的数量。

端点和标头

1. 对端点的 POST 调用**： https://developer-api.openbom.com:443/boms/byparams**
2. 请求头x-openbom-appkey,x-openbom-accesstoken
3. 请求正文内容类型：JSON，名称为 JSON 中传递的密钥

所需输入

1. 访问令牌
2. BOM 名称 - 作为请求正文中 "name "键的值传递。

所需输出

1. OpenBOM 为特定 BOM 返回的行，其中包括 BOM 中不同材料的属性。
2. 用户可根据用例解析 OpenBOM 返回的特定详细信息。

获取特定目录

目的

1. 除了其他各种预定义或定制的属性外，OpenBOM 中的目录还维护着手头零件的库存，可用于在 Tulip 中显示/更新实时库存。
2. 此功能用于获取 OpenBOM 目录中所有可用属性的信息。

端点和标头

1. 对端点的 GET 调用**： https://developer-api.openbom.com:443/bom/{bomid}**
2. 请求标头x-openbom-appkey, x-openbom-accesstoken
3. URL 参数：{catid}- 将作为输入传递。

所需输入

1. 访问令牌
2. CATID：获取感兴趣的特定 BOM 的信息。

所需输出

1. 根据不同的使用情况，用户可以提取 OpenBOM 返回的不同目录属性，其中 "在手数量 "属性可用于在 Tulip 中管理库存和实时更新。

更新目录属性

目的

1. OpenBOM 中的目录维护手头零件的库存，可用于在车间运行的 Tulip 应用程序中显示/更新这些零件的实时库存。
2. 该功能用于实时更新 Catalog 中的属性，例如，"手头数量"（Quantity On Hand）可突出显示用于在车间组装产品的材料库存。由于材料是实时消耗的，因此当操作员使用 Tulip 中的作业指导书应用程序组装单元时，我们可以利用此功能实时更新数量。

端点和标头

1. 对端点的 POST 调用：https://developer-api.openbom.com:443/catalog/{catid}/propertyvalue
2. 请求头x-openbom-appkey, x-openbom-accesstoken
3. 请求正文内容类型 ：JSON
4. 需要在 JSON 中传递 4 个键**-partNumberPropertyName**,partNumber,propertyName,propertyValue

必须输入

1. 访问令牌
2. CATID：URL 参数
3. 部件编号属性名：请求正文中传递的键值
4. 部件编号：请求正文中传递的键值
5. 属性名：请求正文中传递的键值
6. 属性值：请求正文中键值的值

OpenBOM 返回状态 200，表示 "属性已更新 "响应成功。

视频

一小段视频解释了如何在郁金香应用程序中使用 OpenBOM。