API-Referenz

Der primäre Weg zu einem Factory-MBOM-Dokument ist die Factory MBOM-Export-Schaltfläche in der Planer-Kopfzeile, die JSON und CSV direkt herunterlädt. Diese Seite dokumentiert den Maschine-zu-Maschine-Pfad für ERP- und MES-Middleware, die das Dokument selbst abruft.

Beide Pfade liefern dasselbe scalarcut.factory_bom.v1.1-Dokument für dasselbe Projekt.

Endpunkt

GET /v1/tiling/factory-bom

Der Endpunkt ist ein Server-zu-Server-GET auf dem Scalarcut-Embed-Host. Eine authentifizierte Unternehmensintegration fordert das Factory MBOM für eines ihrer eigenen Projekte per scene_id oder project_id an.

Authentifizierung

Senden Sie Ihren Factory-MBOM-Enterprise-Key als Header:

Header	Wert
X-Enterprise-Key	Ihr Factory-MBOM-Enterprise-Key (sc_bom_…). Erforderlich.

Der Zweck des Factory-MBOM-Keys ist getrennt vom Zweck des Storefront-Widgets. Ein Key ohne den Factory-MBOM-Zweck wird mit 401 abgelehnt.

Origin-/Referer-Allowlist

• Ein leerer Origin/Referer ist erlaubt, damit ERP-Middleware, die beides nicht sendet, unverändert funktioniert.
• Ist Origin/Referer vorhanden, muss er zu Ihrer Unternehmens-Allowlist passen (Playground-Keys akzeptieren nur Scalarcut-Marketing-Ursprünge). Eine Abweichung liefert 403.

Abfrageparameter

Parameter	Typ	Bedeutung
scene_id	integer	Optional. Wählt das Projekt per Szenen-ID.
project_id	integer	Optional. Wählt das Projekt per Projekt-ID.

Die Anfrage ist auf das durch den Key identifizierte Unternehmen beschränkt. Bis das Live-Szenen-Abrufen ausgeliefert ist, liefert der Endpunkt das Beispieldokument für jede ID; die von Ihnen gesendeten IDs werden im Nutzungsereignis zur Abrechnung erfasst und wählen das echte Projekt aus, sobald das Abrufen live ist.

Das Beispieldokument

Für Integrator-Tests, Dokumentationsbeispiele und das Try MBOM API-Panel liefert der Endpunkt außerdem ein öffentliches Beispieldokument — die Garage-Fixture. Es sind Beispieldaten und entsprechen demselben scalarcut.factory_bom.v1.1-Schema; es ist kein Beleg dafür, dass das Live-Projekt-Abrufen nicht verfügbar ist.

Bedingte Anfragen

Die Antwort trägt einen ETag (SHA-256 des Körpers). Senden Sie If-None-Match, um das erneute Herunterladen eines unveränderten Dokuments zu überspringen:

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

Eine Übereinstimmung liefert 304 ohne Körper.

Antworten

Status	Bedeutung	Körper
200	Das Factory-MBOM-Dokument.	application/json (scalarcut.factory_bom.v1.1)
304	Nicht geändert (If-None-Match passte).	leer
401	Key fehlt oder ist ungültig.	{ "message": "Unauthorized" }
403	Origin/Referer nicht auf der Unternehmens-Allowlist.	{ "message": "Forbidden" }
429	Ratenlimit überschritten.	—

Die Antwort-Header umfassen:

• ETag — SHA-256-Fingerabdruck des Körpers.
• Cache-Control: private, no-store — nicht zwischen Mandanten cachen.

Ratenlimit

Der Endpunkt ist auf 30 Anfragen pro Minute pro Client gedrosselt. Batch-Abrufe sollten If-None-Match verwenden, um das erneute Herunterladen unveränderter Dokumente zu vermeiden, und Polling verteilen statt den Endpunkt in enger Schleife zu treffen.

Nutzungsmessung

Jeder erfolgreiche Abruf erfasst ein Unternehmens-Nutzungsereignis (Art factory_bom) mit aufgelöster scene_id/project_id und dem Authentifizierungsweg. Dies speist Kontingent und Reporting Ihres Tarifs — und wird nicht an Ihre Käufer gesendet.

Probieren Sie die MBOM API aus

Verwenden Sie die Schaltfläche Try MBOM API unter diesem Artikel, um die Beispielantwort scalarcut.factory_bom.v1.1 in ein Panel zu laden. Die Feldsemantik steht in der Schema-Referenz.