Référence API

La principale façon d'obtenir un document Factory MBOM est le bouton d'export Factory MBOM dans l'en-tête du planificateur, qui télécharge directement le JSON et le CSV. Cette page documente la voie machine à machine pour le middleware ERP et MES qui récupère lui-même le document.

Les deux voies renvoient le même document scalarcut.factory_bom.v1.1 pour le même projet.

Point de terminaison

GET /v1/tiling/factory-bom

Le point de terminaison est un GET de serveur à serveur sur l'hôte d'intégration Scalarcut. Une intégration d'entreprise authentifiée demande le Factory MBOM de l'un de ses propres projets via scene_id ou project_id.

Authentification

Envoyez votre Enterprise Key Factory MBOM comme en-tête :

En-tête	Valeur
X-Enterprise-Key	Votre Enterprise Key Factory MBOM (sc_bom_…). Requis.

La finalité de la clé Factory MBOM est distincte de la finalité du Widget de boutique. Une clé sans la finalité Factory MBOM est rejetée avec 401.

Liste autorisée Origin / Referer

• Un Origin/Referer vide est autorisé, de sorte que le middleware ERP qui n'envoie ni l'un ni l'autre fonctionne sans modification.
• Si Origin/Referer est présent, il doit correspondre à votre liste autorisée d'entreprise (les clés de test n'acceptent que les origines marketing Scalarcut). Une discordance renvoie 403.

Paramètres de requête

Paramètre	Type	Signification
scene_id	integer	Optionnel. Sélectionne le projet par id de scène.
project_id	integer	Optionnel. Sélectionne le projet par id de projet.

La requête est limitée à l'entreprise identifiée par la clé. Jusqu'à la mise en ligne de la récupération de scène en direct, le point de terminaison renvoie le document d'exemple pour tout id ; les ids que vous envoyez sont enregistrés dans l'événement d'usage pour le comptage et sélectionneront le vrai projet une fois la récupération en direct.

Le document d'exemple

Pour les essais d'intégrateurs, les exemples de documentation et le panneau Try MBOM API, le point de terminaison sert aussi un document d'exemple public — le fixture du garage. Ce sont des données d'exemple et elles respectent le même schéma scalarcut.factory_bom.v1.1 ; ce n'est pas la preuve que la récupération de projet en direct est indisponible.

Requêtes conditionnelles

La réponse porte un ETag (SHA-256 du corps). Envoyez If-None-Match pour éviter de retélécharger un document inchangé :

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

Une correspondance renvoie 304 sans corps.

Réponses

Statut	Signification	Corps
200	Le document Factory MBOM.	application/json (scalarcut.factory_bom.v1.1)
304	Non modifié (If-None-Match correspondait).	vide
401	Clé absente ou invalide.	{ "message": "Unauthorized" }
403	Origin/Referer hors de la liste autorisée de l'entreprise.	{ "message": "Forbidden" }
429	Limite de débit dépassée.	—

Les en-têtes de réponse incluent :

• ETag — empreinte SHA-256 du corps.
• Cache-Control: private, no-store — ne pas mettre en cache entre locataires.

Limite de débit

Le point de terminaison est limité à 30 requêtes par minute par client. Les récupérations par lots doivent utiliser If-None-Match pour éviter de retélécharger des documents inchangés, et espacer les sondages plutôt que de marteler le point de terminaison en boucle serrée.

Comptage d'usage

Chaque récupération réussie enregistre un événement d'usage d'entreprise (type factory_bom) portant le scene_id/project_id résolu et la voie d'authentification. Cela alimente le quota et le reporting de votre offre — et n'est pas envoyé à vos acheteurs.

Essayez l'API MBOM

Utilisez le bouton Try MBOM API sous cet article pour charger la réponse d'exemple scalarcut.factory_bom.v1.1 dans un panneau. La sémantique des champs se trouve dans la Référence de schéma.