Riferimento API

Il modo principale per ottenere un documento Factory MBOM è il pulsante di export Factory MBOM nell'intestazione del pianificatore, che scarica direttamente JSON e CSV. Questa pagina documenta il percorso macchina-macchina per il middleware ERP e MES che recupera il documento da sé.

Entrambi i percorsi restituiscono lo stesso documento scalarcut.factory_bom.v1.1 per lo stesso progetto.

Endpoint

GET /v1/tiling/factory-bom

L'endpoint è una GET da server a server sull'host di integrazione Scalarcut. Un'integrazione aziendale autenticata richiede il Factory MBOM di uno dei propri progetti tramite scene_id o project_id.

Autenticazione

Invia la tua Enterprise Key Factory MBOM come header:

Header	Valore
X-Enterprise-Key	La tua Enterprise Key Factory MBOM (sc_bom_…). Obbligatoria.

La finalità della chiave Factory MBOM è distinta dalla finalità del Widget di vetrina. Una chiave senza la finalità Factory MBOM viene rifiutata con 401.

Allowlist Origin / Referer

• Un Origin/Referer vuoto è consentito, così il middleware ERP che non invia nessuno dei due funziona senza modifiche.
• Se Origin/Referer è presente, deve corrispondere alla tua allowlist aziendale (le chiavi playground accettano solo origini marketing Scalarcut). Una discordanza restituisce 403.

Parametri di query

Parametro	Tipo	Significato
scene_id	integer	Opzionale. Seleziona il progetto per id scena.
project_id	integer	Opzionale. Seleziona il progetto per id progetto.

La richiesta è limitata all'azienda identificata dalla chiave. Finché il recupero scena live non viene distribuito, l'endpoint restituisce il documento di esempio per qualsiasi id; gli id che invii sono registrati nell'evento di utilizzo per la misurazione e selezioneranno il progetto reale una volta che il recupero sarà live.

Il documento di esempio

Per prove degli integratori, esempi di documentazione e il pannello Try MBOM API, l'endpoint serve anche un documento di esempio pubblico — il fixture del garage. Sono dati di esempio e sono conformi allo stesso schema scalarcut.factory_bom.v1.1; non sono la prova che il recupero progetto live non sia disponibile.

Richieste condizionali

La risposta porta un ETag (SHA-256 del corpo). Invia If-None-Match per evitare di riscaricare un documento invariato:

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

Una corrispondenza restituisce 304 senza corpo.

Risposte

Stato	Significato	Corpo
200	Il documento Factory MBOM.	application/json (scalarcut.factory_bom.v1.1)
304	Non modificato (If-None-Match corrispondeva).	vuoto
401	Chiave mancante o non valida.	{ "message": "Unauthorized" }
403	Origin/Referer fuori dall'allowlist aziendale.	{ "message": "Forbidden" }
429	Limite di frequenza superato.	—

Gli header di risposta includono:

• ETag — impronta SHA-256 del corpo.
• Cache-Control: private, no-store — non memorizzare in cache tra tenant.

Limite di frequenza

L'endpoint è limitato a 30 richieste al minuto per client. I recuperi batch devono usare If-None-Match per evitare di riscaricare documenti invariati, e distanziare il polling invece di colpire l'endpoint in un ciclo serrato.

Misurazione dell'utilizzo

Ogni recupero riuscito registra un evento di utilizzo aziendale (tipo factory_bom) con scene_id/project_id risolto e la via di autenticazione. Questo alimenta la quota e il reporting del tuo piano — e non viene inviato ai tuoi acquirenti.

Prova l'API MBOM

Usa il pulsante Try MBOM API sotto questo articolo per caricare la risposta di esempio scalarcut.factory_bom.v1.1 in un pannello. La semantica dei campi è nel Riferimento schema.