Referência da API (cliente)

API HTTP JSON para automação de pesagem. Documentação canónica em Markdown: pasta docs/. Esta página é uma síntese para integradores.

Geral

Base URL: substitua pelo seu servidor, por exemplo http://seu-host:8000. Os paths abaixo são relativos a essa base.

Document root: a pasta public/ do repositório. Em desenvolvimento recomenda-se php -S 0.0.0.0:8000 router.php dentro de public/ para o router encaminhar os paths.

Autenticação: os endpoints actuais não implementam autenticação HTTP (Bearer, API key, etc.) nos handlers.

POST — header: Content-Type: application/json

Erros comuns: corpo JSON inválido → 400 invalid_json; validação → 422 validation_error (com details); falha Oracle → 500 database_error. Com APP_DEBUG=1 no .env, erros de BD podem incluir details (apenas desenvolvimento).

POST /precad-automatiza

Pré-cadastro do veículo na integração (integr_erp_conceitto + tagbal).

Doc completa: docs/api-json-precad-automatiza.md

Entrada (body JSON)

Parâmetro	Local	Obrigatório	Tipo	Regras / notas
`tag`	body	Sim	número ou string	Identificador da tag (ligação ao `tagbal`).
`placaCavalo`	body	Sim	string	Placa cavalo.
`dataOrdem`	body	Sim	string	Data/hora da ordem; formatos legados e ISO 8601 com `Z`.
`placaCarreta`	body	Não	string	Omissão = vazio.
`transportador`	body	Não	string	Omissão = vazio.
`motorista`	body	Não	string	Omissão = vazio.
`razaoSocial`	body	Não	string	Omissão = vazio.
`cnpj`	body	Não	string	Omissão = vazio.
`ie`	body	Não	string	Omissão = vazio.
`endereco`	body	Não	string	Omissão = vazio.
`municipio`	body	Não	string	Omissão = vazio.
`uf`	body	Não	string	Omissão = vazio.
`produto`	body	Não	string	Omissão = vazio.
`nrOrdem`	body	Não	número ou string	Omissão = vazio.
`tpPesagem`	body	Não	string	Omissão = vazio.

Saída (sucesso)

HTTP 200 — JSON:

Campo	Tipo	Descrição
`tag`	número	Tag processada.
`status`	inteiro	Retorno da operação de pré-cadastro; sucesso típico = `1`.

Erros (resumo)

HTTP	`error`	Quando
400	`invalid_json`	Corpo vazio ou JSON inválido.
405	`method_not_allowed`	Método diferente de POST.
422	`validation_error`	Falta obrigatório ou `dataOrdem` inválida.
500	`database_error` / `server_error`	Falha de BD ou execução.

{
  "tag": 10000010,
  "placaCavalo": "ABC1234",
  "dataOrdem": "2024-10-30T08:00:00Z"
}

GET /consulta-automatiza

Consulta estado associado a uma balança (resposta sempre com o mesmo conjunto de campos).

Doc completa: docs/api-json-consulta-automatiza.md

Entrada (query string)

Parâmetro	Local	Obrigatório	Tipo	Regras / notas
`scaleId`	query	Um dos dois	inteiro ≥ 1	Número da balança. Também aceite como string só com dígitos.
`bal`	query	Um dos dois	inteiro ≥ 1	Alias de `scaleId`. Se ambos forem enviados, têm de ser iguais.

Exemplo: GET /consulta-automatiza?scaleId=1

Saída (sucesso)

HTTP 200 — sempre o mesmo shape:

Campo	Com dados	Sem dados
`scaleId`	número	número (valor pedido)
`tag`	número	`null`
`placaVeiculo`	string	`""`
`peso1`	número	`null`
`peso2`	número	`null`
`status`	número	`null`
`nrOrdem`	número	`null`

Erros (resumo)

HTTP	`error`	Quando
405	`method_not_allowed`	Método diferente de GET.
422	`validation_error`	Parâmetros em falta, inválidos ou `scaleId` ≠ `bal`.
500	`database_error` / `server_error`	Falha de BD ou execução.

POST /trocastatus-automatiza

Actualiza fg_status, mensagens e opcionalmente peso_ordem_pesagem / observacao em integr_erp_conceitto para uma tag.

Doc completa: docs/api-json-trocastatus-automatiza.md

Entrada (body JSON)

Parâmetro	Local	Obrigatório	Tipo	Regras / notas
`tag`	body	Sim	inteiro ≥ 1	Tag do registo a actualizar.
`status`	body	Sim	inteiro	`0`: não altera `fg_status`; só mensagens (e opcionalmente peso). ≠0: actualiza `fg_status`.
`messages`	body	Não	array de strings	Até 3 entradas → `mensagem_1`…`3`. Omissão ou `[]` → três vazias.
`pesoOrdem`	body	Não	número / string numérica	Se preenchido (trim não vazio e numérico), inclui `peso_ordem_pesagem` no UPDATE.
`observacao`	body	Não	string	Omissão = vazio.

Saída (sucesso)

HTTP 200

Campo	Tipo	Descrição
`tag`	inteiro	Tag enviada.
`status`	inteiro	Valor devolvido após sucesso (em condições normais coincide com o pedido).

Erros (resumo)

HTTP	`error`	Quando
400	`invalid_json`	Corpo vazio ou JSON inválido.
405	`method_not_allowed`	Método diferente de POST.
422	`validation_error`	Validação de `tag`, `status`, `messages`, `pesoOrdem`.
500	`database_error` / `server_error`	Falha de BD ou execução.

{
  "tag": 10000010,
  "status": 7,
  "messages": ["Linha 1", "Linha 2", "Linha 3"]
}

POST /classifica-automatiza

Dados para ticket e classificação (TICKETGER, CLASSIFICA). Obrigatório no fluxo de pesagem mesmo sem classificação — use descontos: [].

Doc completa: docs/api-json-classifica-automatiza.md

Entrada (body JSON)

Parâmetro	Local	Obrigatório	Tipo	Regras / notas
`nrOrdem`	body	Sim	inteiro ≥ 1	Ordem de pesagem; tem de existir em `integr_erp_conceitto_log`.
`numMoega`	body	Sim	inteiro	Moega.
`numNota`	body	Sim	string ou número	Número da nota.
`numTicket`	body	Sim	inteiro	Ticket.
`pesoSeco`	body	Sim	inteiro	Peso seco.
`pesoLiquido`	body	Sim	inteiro	Peso líquido.
`descontos`	body	Não (tratado como [])	array	Lista de `{ "descricao", "valor" }`. Itens com descrição não vazia inserem em `CLASSIFICA`.
`origem`, `destino`, `produto`, `usuarioPesagem`, `usuarioPesagem2`, `transportador`, `motorista`, `cidade`, `uf`, `tpAcondicionamento`, `dsObservacao`	body	Não	string	Omissão = string vazia.

Saída (sucesso)

HTTP 200

Campo	Tipo	Descrição
`message`	string	Confirmação fixa de sucesso.

{ "message": "Dados de classificação recebidos com sucesso" }

Erros (resumo)

HTTP	`error`	Quando
400	`invalid_json`	Corpo vazio ou JSON inválido.
405	`method_not_allowed`	Método diferente de POST.
422	`validation_error`	Campos ou tipos inválidos.
404	`not_found`	Sem linha no log para `nrOrdem`.
500	`database_error` / `server_error`	Falha de BD ou execução.

POST /gera-ticket-automatiza

Comando de impressão / reimpressão: UPDATE TICKETGER SET STATUS = 0 WHERE PEDIDO = nrOrdem.

Doc completa: docs/api-json-gera-ticket-automatiza.md

Entrada (body JSON)

Parâmetro	Local	Obrigatório	Tipo	Regras / notas
`nrOrdem`	body	Sim	inteiro ≥ 1	Ordem de pesagem (`PEDIDO`).
`status`	body	Sim	inteiro	Obrigatório no JSON por compatibilidade; não é usado no SQL — o UPDATE fixa sempre `STATUS = 0`.

Saída (sucesso)

HTTP 200 — mesmo que não exista linha em TICKETGER (0 linhas afectadas), o legado considera sucesso se o execute não falhar.

Campo	Tipo	Descrição
`message`	string	Confirmação fixa de sucesso.

{
  "nrOrdem": 10,
  "status": 1
}

{ "message": "Ticket enviado para impressão" }

Erros (resumo)

HTTP	`error`	Quando
400	`invalid_json`	Corpo vazio ou JSON inválido.
405	`method_not_allowed`	Método diferente de POST.
422	`validation_error`	`nrOrdem` ou `status` inválidos.
500	`database_error` / `server_error`	Falha de BD ou execução.