Pular para conteúdo

Endpoints REST

Todos os endpoints são self-register (@Get/@Post no próprio .tlpp) e exigem token Bearer (exceto o endpoint de emissão de token). Base de URL: /rest.

Autenticação obrigatória

Cada endpoint valida u_validaToken(U_ApBearer(oHeader)). Sem token / token inválido → 401. Veja Autenticação.

Consulta (GET)

Endpoint Finalidade Tabelas / origem
apt001 Operações da OP + sessões ativas SC2 × SB1 × SG2 × SH6; MLTEC_0051
apt002 Lista de recursos SH1
apt003 Busca de operadores SRA
apt009 Detalhe da sessão + pausas MLTEC_0051, MLTEC_0052
apt010 Histórico de apontamentos de produção SH6 × SC2 × SG2 × SRA
apt014 OPs abertas (busca) SC2 × SB1
apt015 Motivos de parada CYN
apt016 Lookup de OP / produto MLTEC_0051 × SC2 × SB1
apt017 Motivos de refugo/perda CYO
apt019 Insumos / empenho da OP SD4 × SB1
apt020 Histórico de refugo/perda SBC × SB1 × CYO × SRA
apt023 Base de conhecimento (documentos PDF em BASE64) AC9 × ACB
apt030 Consulta da auditoria MLTEC_0054 × SRA

Escrita (POST)

Endpoint Finalidade Efeito
apt004 Iniciar sessão de apontamento Cria MLTEC_0051 (STATUS I)
apt005 Pausar sessão Abre pausa em MLTEC_0052, STATUS P
apt006 Retomar sessão Fecha a pausa, acumula TPAUSE
apt007 Apontar produção Grava SH6 via MATA681
apt008 Parar / descartar sessão Finaliza MLTEC_0051
apt011 Pré-checagem de estorno (UX) Não altera dados
apt012 Estorno com senha de supervisor Identifica por R_E_C_N_O_ (AUTRECNO); valida no servidor; estorna ou 401
apt013 Encerrar OP SC2.C2_DATRF via MATA250
apt018 Apontar refugo/perda Grava SBC via MATA685 (opção 3)
apt024 Estornar perda (documento SBC) MATA685 opção 6 por BC_NUMSEQ; reverte o estoque (SD3); exige supervisor; 401

Convenções de resposta (padrão TLPP)

  • POST de criação → 201; token inválido → 401; entrada fora do formato → 400.
  • Toda query usa WITH (NOLOCK), D_E_L_E_T_ = ' ' e WHERE 1=1 AND ....
  • Todo input de usuário passa por whitelist (utilApt) e/ou FwPreparedStatement antes da query.
  • Respostas em UTF-8 (EncodeUTF8); as fontes .tlpp permanecem ASCII.

Helpers e configuração (não são endpoints de negócio)

Fonte Papel
utilApt Validação de entrada (U_ApValOP, U_ApValOperador, U_ApValRecurso…), guardas de OP encerrada, logger, Ponto de Entrada U_ApPE
mltecLog Grava a auditoria (U_MLTLogMLTEC_0054)
config_server/paramsProvider Provider OAuth2 (valida a conta de serviço na MLTEC_0053)
config_server/validaToken Valida o token dos endpoints
config_server/noCheckUri Whitelist de URIs sem token (só o endpoint de token)
config_server/RestConfigurationOnStart Abre o ambiente no start do REST (OnStart do pool)