Referencia de API

La forma principal de obtener un documento Factory MBOM es el botón de exportación Factory MBOM en la cabecera del planificador, que descarga el JSON y el CSV directamente. Esta página documenta la vía máquina a máquina para el middleware ERP y MES que obtiene el documento por sí mismo.

Ambas vías devuelven el mismo documento scalarcut.factory_bom.v1.1 para el mismo proyecto.

Endpoint

GET /v1/tiling/factory-bom

El endpoint es un GET de servidor a servidor en el host de integración de Scalarcut. Una integración empresarial autenticada solicita el Factory MBOM de uno de sus propios proyectos mediante scene_id o project_id.

Autenticación

Envía tu Enterprise Key de Factory MBOM como cabecera:

Cabecera	Valor
X-Enterprise-Key	Tu Enterprise Key de Factory MBOM (sc_bom_…). Obligatoria.

El propósito de la clave Factory MBOM es distinto del propósito del Widget de tienda. Una clave sin el propósito Factory MBOM se rechaza con 401.

Lista permitida de Origin / Referer

• Un Origin/Referer vacío está permitido, de modo que el middleware ERP que no envía ninguno funciona sin cambios.
• Si Origin/Referer está presente, debe coincidir con tu lista permitida empresarial (las claves de prueba aceptan solo orígenes de marketing de Scalarcut). Una discrepancia devuelve 403.

Parámetros de consulta

Parámetro	Tipo	Significado
scene_id	integer	Opcional. Selecciona el proyecto por id de escena.
project_id	integer	Opcional. Selecciona el proyecto por id de proyecto.

La solicitud está limitada a la empresa identificada por la clave. Hasta que se publique la recuperación de escena en vivo, el endpoint devuelve el documento de muestra para cualquier id; los ids que envíes se registran en el evento de uso para la medición y seleccionarán el proyecto real una vez que la recuperación esté en vivo.

El documento de muestra

Para pruebas de integradores, ejemplos de documentación y el panel Try MBOM API, el endpoint también sirve un documento de muestra público: el fixture del garaje. Son datos de muestra y se ajustan al mismo esquema scalarcut.factory_bom.v1.1; no son evidencia de que la recuperación de proyectos en vivo no esté disponible.

Solicitudes condicionales

La respuesta lleva un ETag (SHA-256 del cuerpo). Envía If-None-Match para omitir la redescarga de un documento sin cambios:

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

Una coincidencia devuelve 304 sin cuerpo.

Respuestas

Estado	Significado	Cuerpo
200	El documento Factory MBOM.	application/json (scalarcut.factory_bom.v1.1)
304	No modificado (If-None-Match coincidió).	vacío
401	Clave ausente o no válida.	{ "message": "Unauthorized" }
403	Origin/Referer no está en la lista permitida de la empresa.	{ "message": "Forbidden" }
429	Límite de tasa superado.	—

Las cabeceras de respuesta incluyen:

• ETag: huella SHA-256 del cuerpo.
• Cache-Control: private, no-store: no almacenar en caché entre inquilinos.

Límite de tasa

El endpoint está limitado a 30 solicitudes por minuto por cliente. Las obtenciones por lotes deben usar If-None-Match para evitar redescargar documentos sin cambios, y espaciar el sondeo en lugar de golpear el endpoint en un bucle cerrado.

Medición de uso

Cada obtención exitosa registra un evento de uso empresarial (tipo factory_bom) con el scene_id/project_id resuelto y la ruta de autenticación. Esto alimenta la cuota y los informes de tu plan, y no se envía a tus compradores.

Prueba la API MBOM

Usa el botón Try MBOM API debajo de este artículo para cargar la respuesta de muestra scalarcut.factory_bom.v1.1 en un panel. La semántica de los campos está en la Referencia de esquema.