Разъем OpenBOM

Коннектор OpenBOM

Интеграция Tulip с OpenBOM с помощью HTTP-коннектора Tulip

Введение

OpenBOM - это облачная технология совместной работы и управления данными в режиме реального времени, которая позволяет управлять деталями, каталогами, спецификациями, запасами и заказами на поставку в сетях инженеров, менеджеров цепочек поставок и контрактных производителей. Цель данного коннектора - интегрировать OpenBOM с Tulip с помощью HTTP-коннекторов Tulip и предоставить вам готовый коннектор OpenBOM, который можно импортировать в ваш экземпляр.

Назначение

1. Мы рассмотрим различные функции HTTP-коннектора, которые могут быть созданы путем выполнения HTTP-вызовов к конечным точкам OpenBOM для получения информации о настроенных спецификациях материалов (BOM), поддерживаемых каталогах и получения информации о спецификациях производственных заказов, выпущенных в OpenBOM.
2. Приложения Tulip могут быть созданы для настройки рабочих инструкций для операторов в цехе, которые извлекают информацию о производственных заказах, выделяя детали, необходимые операторам для сборки изделий и выполнения производственных заказов в цехе. Используя каталоги в OpenBOMs, мы покажем, как менеджеры цехов могут в режиме реального времени поддерживать инвентаризацию различных деталей, необходимых для сборки изделия в цехе.

API Doc

В следующих функциях коннекторов, представленных в данном документе, использовались API-документы OpenBOM.

Предварительные требования

1. Создайте учетную запись на OpenBOM и настройте OpenBOM Catalogs & BOM для продукта, который будет собираться в цеху.
2. Вам необходимо сгенерировать API-ключ, который используется в коннекторах Tulip для установления соединений с OpenBOM.
3. Используя базовую аутентификацию (имя пользователя и пароль), получите токен доступа (см. ниже), который будет передаваться в качестве заголовка запроса во всех функциях коннектора.

Детали подключения Tulip

Для HTTP-коннектора Tulip необходимо настроить следующую информацию.

1. Running On: Cloud Connector Host
2. Хост: developer-api.openbom.com
3. Порт: 443
4. TLS: Да
5. Аутентификация: No 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. Этот список может быть использован для извлечения идентификаторов каталогов, которые могут быть использованы для использования конкретных каталогов для извлечения текущих запасов для различных материалов и обновления различных свойств в каталоге в режиме реального времени.

Конечная точка и заголовки

1. Вызов конечной точки GET: https://developer-api.openbom.com:443/catalogs.
2. Заголовки запроса: x-openbom-appkey, x-openbom-accesstoken

Требуемый ввод

1. Токен доступа, передаваемый переменной, которая требуется в качестве заголовка запроса при HTTP-вызове к указанной конечной точке.

Необходимые выходные экстракторы

1. CatalogId - может быть использован для вызова конкретных каталогов, представляющих интерес.

Получение списка спецификаций

Назначение

1. Данная конечная точка предоставляет список BOM, доступных в профиле OpenBOM пользователя.
2. Из этого списка можно извлечь идентификаторы BOM или названия BOM, которые могут быть использованы для получения информации о различных деталях, необходимых для завершения сборки изделия в цеху.

Конечная точка и заголовки

1. GET-вызов конечной точки: https://developer-api.openbom.com:443/boms.
2. Заголовки запроса x-openbom-appkey, x-openbom-accesstoken

Требуемый ввод

1. Токен доступа, передаваемый переменной, которая требуется в качестве заголовка запроса при HTTP-вызове к указанной конечной точке.

Необходимые выходные экстракторы

1. BOMId - может быть использован для вызова конкретных BOM, представляющих интерес.
2. Name - может быть использован для выполнения POST-запроса для вызова конкретного BOM, передавая свойство Name.

Получение BOM производственного заказа

Назначение

1. Эта функция извлекает BOM производственного заказа, когда конкретный BOM для сборки единицы продукции выпускается в производство на OpenBOM.
2. Эта функция коннектора извлекает важные детали (Name, BOMID, Number of Units) о производственном заказе, которые будут динамически переданы для вызова определенного BOM ID, который будет содержать всю информацию об общем количестве деталей, необходимых оператору для выполнения всего производственного заказа.

Конечная точка и заголовки

1. GET-вызов конечной точки: https://developer-api.openbom.com:443/orderboms.
2. Заголовки запроса: x-openbom-appkey, x-openbom-accesstoken

Требуемый ввод

1. Токен доступа, передаваемый переменной, которая требуется в качестве заголовка запроса при HTTP-вызове к указанной конечной точке.

Необходимые выходные экстракторы

1. Name - может использоваться для получения информации о конкретном производственном BOM путем передачи Name в конечную точку BOM.
2. BOMID - Это свойство можно использовать для получения подробной информации о конкретной производственной спецификации, передавая идентификатор в конечную точку BOM.
3. numUnits - Это свойство может использоваться для указания количества единиц продукции, которое должно быть произведено в цехе для одного производственного заказа.

Получение конкретной BOM

Назначение

1. Эта функция позволяет получить свойства всех различных материалов, входящих в конкретную спецификацию для сборки единицы продукции.
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. Строки, возвращаемые OpenBOM для конкретного BOM, которые включают свойства различных материалов, входящих в состав BOM.
2. Пользователи могут анализировать конкретные данные, возвращаемые OpenBOM, в зависимости от конкретного случая использования.

Получение конкретной спецификации по имени

Назначение

1. Эта функция позволяет получить свойства всех различных материалов, входящих в конкретную спецификацию для сборки узла, передавая вместо идентификатора имя спецификации.
2. Строки, возвращаемые OpenBOM, могут быть разобраны в Tulip, которые используются для отображения количества различных сырьевых материалов, необходимых для выполнения производственного заказа, в дополнение ко всем другим свойствам BOM, возвращаемым OpenBOM в зависимости от того, как настроен BOM.

Конечная точка и заголовки

1. POST-вызов конечной точки: https://developer-api.openbom.com:443/boms/byparams.
2. Заголовок запроса x-openbom-appkey, x-openbom-accesstoken
3. Тело запроса Content-Type:JSON , имя как ключ, переданный в JSON

Необходимые входные данные

1. Токен доступа
2. BOM NAME - передается как значение ключа 'name' в теле запроса.

Требуемые выходные данные

1. Строки, возвращаемые OpenBOM для конкретного BOM, которые включают свойства различных материалов, входящих в состав BOM.
2. Пользователи могут анализировать конкретные данные, возвращаемые OpenBOM, в зависимости от конкретного случая использования.

Получение конкретного каталога

Назначение

1. В дополнение к различным другим предопределенным или настраиваемым свойствам, каталоги в OpenBOM поддерживают инвентаризацию имеющихся деталей, которая может быть использована для отображения/обновления инвентаризации в реальном времени в Tulip.
2. Данная функция используется для получения информации обо всех свойствах, доступных в OpenBOMs Catalogs.

Конечная точка и заголовки

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. PartNumberPropertyName: Значение для ключа, переданного в теле запроса
4. PartNumber: Значение для ключа, переданного в теле запроса
5. PropertyName: Значение для ключа, переданного в теле запроса
6. PropertyValue: Значение для ключа, переданного в теле запроса

OpenBOM возвращает статус 200 с успешным ответом "Property Updated".

Видео

Небольшой видеоролик, объясняющий, как можно использовать OpenBOM в приложении Tulip.