/wp-json/jwt-auth/v1/token
Obter Token
Autentica o usuário por meio de username e
password e retorna o token JWT para acesso às rotas protegidas.
API REST GLOBAL BÁSICA — GLB-1.1
A API permite integrar informações operacionais e financeiras do UPLog, incluindo geradores, contratos, boletins de medição, boletos, NFS-e, MTRs com coletas, motivos de não coleta e lançamentos financeiros.
11
endpoints
21
operações HTTP
5
rotas de consulta
JWT
autenticação Bearer
Nenhuma rota encontrada para os filtros informados.
Autenticação
Geração do token JWT utilizado nas demais requisições.
Geradores
Cadastro e manutenção dos clientes geradores no UPLog.
/wp-json/api/v11/gerador
Cadastro de Gerador
Cadastra um novo gerador com CNPJ ou CPF, razão social, nome fantasia, código externo e status.
Status aceitos: A — Ativo, S — Suspenso e D — Desativado./wp-json/api/v11/gerador
Edição de Gerador
Atualiza os dados cadastrais e o status de um gerador existente, identificado pelo código do cliente.
/wp-json/api/v11/gerador
Exclusão de Gerador
Exclui um gerador existente utilizando o parâmetro
codigoCliente.
Contratos
Cadastro e manutenção dos contratos, locais de faturamento, locais de coleta e resíduos.
/wp-json/api/v11/contrato
Cadastro de Contrato
Cadastra um contrato com identificação do cliente, dados de contato, local de faturamento, locais de coleta, resíduos e frequências.
Frequências suportadas: conforme solicitado, diária, semanal, mensal e por sequência da semana./wp-json/api/v11/contrato
Edição de Contrato
Atualiza um contrato existente, incluindo seus dados gerais, local de faturamento, locais de coleta, resíduos e frequências.
/wp-json/api/v11/contrato
Exclusão de Contrato
Exclui um contrato por meio dos parâmetros
codigoCliente e codigoContrato.
Integração externa de medições
Webhook configurado pelo integrador para receber os boletins de medição gerados no UPLog.
{API Externa}
Integração de Medição
Envia para o sistema externo uma nova medição, com contrato, emissão, vencimento, referência, itens e valores.
O endereço é definido na configuração da integração.{API Externa}
Edição de Medição
Comunica ao sistema externo a atualização de uma medição já integrada.
{API Externa}
Exclusão de Medição
Solicita ao sistema externo a exclusão de uma medição pelo
codigoMedicao.
NFS-e
Recebimento e manutenção de Notas Fiscais de Serviço vinculadas a uma medição.
/wp-json/api/v11/nfse
Cadastro de NFS-e
Registra uma NFS-e emitida no sistema externo, incluindo número, medição, data, status, valor, motivo, PDF e XML em base64.
/wp-json/api/v11/nfse
Edição de NFS-e
Atualiza os dados ou o status de uma NFS-e já vinculada à medição.
/wp-json/api/v11/nfse
Exclusão de NFS-e
Exclui uma NFS-e utilizando o parâmetro numeroNfse.
Boletos
Recebimento e manutenção dos boletos vinculados aos boletins de medição.
/wp-json/api/v11/boleto
Cadastro de Boleto
Registra um boleto com número externo, nosso número, datas, valores, status, motivo e PDF em base64.
/wp-json/api/v11/boleto
Edição de Boleto
Atualiza os dados, o valor ou o status de um boleto existente.
/wp-json/api/v11/boleto
Exclusão de Boleto
Exclui um boleto utilizando o parâmetro numeroBoleto.
Consultas
Rotas de leitura para dados operacionais, fiscais e financeiros.
/wp-json/api/v11/lista-coleta
Buscar MTRs com Coletas
Retorna MTRs e suas respectivas coletas dentro do período informado.
Filtros obrigatórios:dataInicio e dataFim.
/wp-json/api/v11/lista-nfse
Buscar NFS-e
Retorna dados fiscais e financeiros das NFS-e conforme os filtros informados.
Filtros:de, ate, cnpj,
codigoGerador e referencia.
/wp-json/api/v11/lista-motivo
Listar Motivos de Não Coleta
Retorna todos os motivos de não coleta cadastrados, incluindo regras de observação, coleta, foto, assinatura e status.
Esta rota não possui parâmetros de busca./wp-json/api/v11/lista-medicao
Buscar Medições
Retorna boletins de medição, itens faturados, valores, referência, emissão e vencimento.
Filtros obrigatórios:de e ate.
Filtros opcionais: cnpj e referencia.
/wp-json/api/v11/lista-financeiro
Buscar Lançamentos Financeiros
Retorna lançamentos financeiros com valores, vencimento, pagamento, categoria, conta, fornecedor, vínculo, tipo e status.
Filtros: período, tipo de busca, tipo de lançamento, descrição e status.