Справочник API

Основной способ получить документ Factory MBOM — кнопка экспорта Factory MBOM в шапке планировщика, которая скачивает JSON и CSV напрямую. Эта страница описывает путь «машина-машина» для промежуточного ПО ERP и MES, которое само получает документ.

Оба пути возвращают один и тот же документ scalarcut.factory_bom.v1.1 для одного и того же проекта.

Конечная точка

GET /v1/tiling/factory-bom

Конечная точка — это сервер-серверный GET на хосте встраивания Scalarcut. Авторизованная интеграция предприятия запрашивает Factory MBOM для одного из собственных проектов по scene_id или project_id.

Авторизация

Передайте ваш Enterprise Key Factory MBOM в заголовке:

Заголовок	Значение
X-Enterprise-Key	Ваш Enterprise Key Factory MBOM (sc_bom_…). Обязателен.

Назначение ключа Factory MBOM отличается от назначения виджета витрины. Ключ без назначения Factory MBOM отклоняется с 401.

Список разрешённых Origin / Referer

• Пустой Origin/Referer допускается, поэтому промежуточное ПО ERP, не отправляющее ни того, ни другого, работает без изменений.
• Если Origin/Referer присутствует, он должен совпадать со списком разрешённых адресов вашего предприятия (пробные ключи принимают только маркетинговые адреса Scalarcut). Несовпадение возвращает 403.

Параметры запроса

Параметр	Тип	Смысл
scene_id	integer	Необязательный. Выбирает проект по идентификатору сцены.
project_id	integer	Необязательный. Выбирает проект по идентификатору проекта.

Запрос ограничен предприятием, определённым по ключу. Пока не реализовано живое получение сцены, конечная точка возвращает образец документа для любого идентификатора; отправленные вами идентификаторы записываются в событие использования для учёта и будут выбирать реальный проект, как только получение станет живым.

Образец документа

Для проб интеграторов, примеров документации и панели Try MBOM API конечная точка также отдаёт публичный образец документа — «гаражный» фикстур. Это образец данных, соответствующий той же схеме scalarcut.factory_bom.v1.1; он не является доказательством того, что живое получение проекта недоступно.

Условные запросы

Ответ несёт ETag (SHA-256 тела). Отправляйте If-None-Match, чтобы не скачивать повторно неизменённый документ:

curl -sS -H "X-Enterprise-Key: sc_bom_…" \
  -H 'If-None-Match: "<etag>"' \
  "/v1/tiling/factory-bom"

Совпадение возвращает 304 без тела.

Ответы

Статус	Смысл	Тело
200	Документ Factory MBOM.	application/json (scalarcut.factory_bom.v1.1)
304	Не изменён (If-None-Match совпал).	пусто
401	Ключ отсутствует или неверен.	{ "message": "Unauthorized" }
403	Origin/Referer не в списке разрешённых предприятия.	{ "message": "Forbidden" }
429	Превышен лимит запросов.	—

Заголовки ответа включают:

• ETag — отпечаток SHA-256 тела.
• Cache-Control: private, no-store — не кэшировать между арендаторами.

Лимит запросов

Конечная точка ограничена 30 запросами в минуту на клиента. Пакетные выборки должны использовать If-None-Match, чтобы не скачивать повторно неизменённые документы, и распределять опросы, а не дёргать конечную точку в плотном цикле.

Учёт использования

Каждая успешная выборка записывает событие использования предприятия (тип factory_bom) с разрешёнными scene_id/project_id и маршрутом авторизации. Это идёт в квоту и отчётность вашего тарифа — и не отправляется вашим покупателям.

Попробуйте MBOM API

Используйте кнопку Try MBOM API под этой статьёй, чтобы загрузить образец ответа scalarcut.factory_bom.v1.1 в панель. Семантика полей — в Справочнике схемы.