Referencja API

Podstawowym sposobem uzyskania dokumentu Factory MBOM jest przycisk eksportu Factory MBOM w nagłówku planera, który pobiera bezpośrednio JSON i CSV. Ta strona dokumentuje ścieżkę maszyna-maszyna dla middleware ERP i MES, które samo pobiera dokument.

Obie ścieżki zwracają ten sam dokument scalarcut.factory_bom.v1.1 dla tego samego projektu.

Punkt końcowy

GET /v1/tiling/factory-bom

Punkt końcowy to GET serwer-serwer na hoście osadzenia Scalarcut. Uwierzytelniona integracja przedsiębiorstwa żąda Factory MBOM dla jednego z własnych projektów przez scene_id lub project_id.

Uwierzytelnianie

Wyślij swój Enterprise Key Factory MBOM jako nagłówek:

Nagłówek	Wartość
X-Enterprise-Key	Twój Enterprise Key Factory MBOM (sc_bom_…). Wymagany.

Cel klucza Factory MBOM różni się od celu Widgetu witryny. Klucz bez celu Factory MBOM jest odrzucany z 401.

Allowlist Origin / Referer

• Pusty Origin/Referer jest dozwolony, więc middleware ERP, które nie wysyła żadnego z nich, działa bez zmian.
• Jeśli Origin/Referer jest obecny, musi pasować do Twojej allowlisty przedsiębiorstwa (klucze testowe akceptują tylko marketingowe źródła Scalarcut). Niezgodność zwraca 403.

Parametry zapytania

Parametr	Typ	Znaczenie
scene_id	integer	Opcjonalny. Wybiera projekt po id sceny.
project_id	integer	Opcjonalny. Wybiera projekt po id projektu.

Żądanie jest ograniczone do przedsiębiorstwa zidentyfikowanego przez klucz. Dopóki nie zostanie wdrożone pobieranie sceny na żywo, punkt końcowy zwraca przykładowy dokument dla dowolnego id; wysyłane przez Ciebie id są rejestrowane w zdarzeniu użycia do pomiaru i wybiorą rzeczywisty projekt, gdy pobieranie będzie na żywo.

Przykładowy dokument

Dla testów integratorów, przykładów w dokumentacji i panelu Try MBOM API punkt końcowy udostępnia również publiczny przykładowy dokument — fixture garażu. To dane przykładowe zgodne z tym samym schematem scalarcut.factory_bom.v1.1; nie są dowodem na to, że pobieranie projektu na żywo jest niedostępne.

Żądania warunkowe

Odpowiedź zawiera ETag (SHA-256 treści). Wyślij If-None-Match, aby pominąć ponowne pobieranie niezmienionego dokumentu:

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

Zgodność zwraca 304 bez treści.

Odpowiedzi

Status	Znaczenie	Treść
200	Dokument Factory MBOM.	application/json (scalarcut.factory_bom.v1.1)
304	Niezmieniony (If-None-Match pasował).	pusta
401	Brakujący lub nieprawidłowy klucz.	{ "message": "Unauthorized" }
403	Origin/Referer poza allowlistą przedsiębiorstwa.	{ "message": "Forbidden" }
429	Przekroczono limit zapytań.	—

Nagłówki odpowiedzi obejmują:

• ETag — odcisk SHA-256 treści.
• Cache-Control: private, no-store — nie buforować między najemcami.

Limit zapytań

Punkt końcowy jest ograniczony do 30 żądań na minutę na klienta. Pobierania wsadowe powinny używać If-None-Match, aby nie pobierać ponownie niezmienionych dokumentów, i rozkładać odpytywanie zamiast uderzać w punkt końcowy w ciasnej pętli.

Pomiar użycia

Każde udane pobranie rejestruje zdarzenie użycia przedsiębiorstwa (typ factory_bom) z rozwiązanym scene_id/project_id i ścieżką uwierzytelniania. To zasila limit i raportowanie Twojego planu — i nie jest wysyłane do Twoich kupujących.

Wypróbuj API MBOM

Użyj przycisku Try MBOM API pod tym artykułem, aby załadować przykładową odpowiedź scalarcut.factory_bom.v1.1 do panelu. Semantyka pól jest w Referencji schematu.