Referência de API

A principal forma de obter um documento Factory MBOM é o botão de exportação Factory MBOM no cabeçalho do planejador, que baixa o JSON e o CSV diretamente. Esta página documenta o caminho máquina a máquina para middleware ERP e MES que obtém o documento por conta própria.

Ambos os caminhos retornam o mesmo documento scalarcut.factory_bom.v1.1 para o mesmo projeto.

Endpoint

GET /v1/tiling/factory-bom

O endpoint é um GET de servidor para servidor no host de integração Scalarcut. Uma integração empresarial autenticada solicita o Factory MBOM de um de seus próprios projetos por scene_id ou project_id.

Autenticação

Envie sua Enterprise Key do Factory MBOM como cabeçalho:

Cabeçalho	Valor
X-Enterprise-Key	Sua Enterprise Key do Factory MBOM (sc_bom_…). Obrigatória.

A finalidade da chave Factory MBOM é distinta da finalidade do Widget de loja. Uma chave sem a finalidade Factory MBOM é rejeitada com 401.

Lista de permissões Origin / Referer

• Um Origin/Referer vazio é permitido, então o middleware ERP que não envia nenhum deles funciona sem alterações.
• Se Origin/Referer estiver presente, deve corresponder à sua lista de permissões empresarial (chaves de teste aceitam apenas origens de marketing Scalarcut). Uma divergência retorna 403.

Parâmetros de consulta

Parâmetro	Tipo	Significado
scene_id	integer	Opcional. Seleciona o projeto por id de cena.
project_id	integer	Opcional. Seleciona o projeto por id de projeto.

A solicitação é limitada à empresa identificada pela chave. Até a recuperação de cena ao vivo ser enviada, o endpoint retorna o documento de exemplo para qualquer id; os ids que você envia são registrados no evento de uso para medição e selecionarão o projeto real assim que a recuperação estiver ao vivo.

O documento de exemplo

Para testes de integradores, exemplos de documentação e o painel Try MBOM API, o endpoint também serve um documento de exemplo público — o fixture da garagem. São dados de exemplo e estão em conformidade com o mesmo esquema scalarcut.factory_bom.v1.1; não são evidência de que a recuperação de projetos ao vivo esteja indisponível.

Solicitações condicionais

A resposta carrega um ETag (SHA-256 do corpo). Envie If-None-Match para pular o re-download de um documento inalterado:

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

Uma correspondência retorna 304 sem corpo.

Respostas

Status	Significado	Corpo
200	O documento Factory MBOM.	application/json (scalarcut.factory_bom.v1.1)
304	Não modificado (If-None-Match correspondeu).	vazio
401	Chave ausente ou inválida.	{ "message": "Unauthorized" }
403	Origin/Referer fora da lista de permissões da empresa.	{ "message": "Forbidden" }
429	Limite de taxa excedido.	—

Os cabeçalhos de resposta incluem:

• ETag — impressão digital SHA-256 do corpo.
• Cache-Control: private, no-store — não armazenar em cache entre locatários.

Limite de taxa

O endpoint é limitado a 30 solicitações por minuto por cliente. Obtenções em lote devem usar If-None-Match para evitar re-download de documentos inalterados, e espaçar o polling em vez de atingir o endpoint em um loop apertado.

Medição de uso

Cada obtenção bem-sucedida registra um evento de uso empresarial (tipo factory_bom) com o scene_id/project_id resolvido e a rota de autenticação. Isso alimenta a cota e os relatórios do seu plano — e não é enviado aos seus compradores.

Experimente a API MBOM

Use o botão Try MBOM API abaixo deste artigo para carregar a resposta de exemplo scalarcut.factory_bom.v1.1 em um painel. A semântica dos campos está na Referência de esquema.