Pular para o conteúdo

Referência de endpoints (v2)

Base: https://api.mysebr.com.br/nfemyse/rest. Todos os endpoints (exceto /health*) exigem o header Authorization: Token. São 34 endpoints no total.

NFe — /nfe

MétodoCaminhoDescrição
GET/nfeLista NFes
GET/nfe/paginacao/{pagina}/{quantidade}Lista NFes paginadas
GET/nfe/nota/{recibo}Consulta 1 NFe pelo recibo (resultado do polling)
GET/nfe/nota/{recibo}/completaNFe completa (itens, faturas, transporte)
GET/nfe/correcao/{recibo}Resultado de uma carta de correção (evento 110110)
GET/nfe/cancelamento/{recibo}Resultado de um cancelamento (evento 110111)
POST/nfe/emissaoEmite uma NFe (assíncrono → recibo)
PUT/nfe/{id}Altera uma NFe ainda não emitida
POST/nfe/correcaoEnvia carta de correção (→ recibo)
POST/nfe/cancelamentoCancela uma NFe por chave (→ recibo)

NFCe — /nfce

MétodoCaminhoDescrição
GET/nfceLista NFCe
GET/nfce/paginacao/{pagina}/{quantidade}Lista NFCe paginadas
GET/nfce/cupom/{recibo}Consulta 1 cupom pelo recibo
GET/nfce/cupom/{recibo}/completaCupom completo (com itens)
GET/nfce/cancelamento/{recibo}Resultado de cancelamento do cupom
POST/nfce/emissaoEmite uma NFCe (assíncrono → recibo)
POST/nfce/cancelamentoCancela um cupom (→ recibo)
PUT/nfce/{id}Altera um cupom não emitido

NFSe — /nfse

MétodoCaminhoDescrição
POST/nfse/emissaoEmite uma NFSe (assíncrono → recibo)

Clientes — /clientes

MétodoCaminhoDescrição
GET/clientesLista clientes
GET/clientes/{doc}Busca cliente por CPF/CNPJ
GET/clientes/busca/{nome}Busca por nome (top_clientes → top 20 por relevância)
POST/clientesCadastra um cliente
PUT/clientes/{doc}Atualiza um cliente por documento
DELETE/clientes/{doc}Exclui um cliente por documento

Produtos — /produtos

MétodoCaminhoDescrição
GET/produtosLista produtos
GET/produtos/{ref}Produto por referência
GET/produtos/paginacao/{pagina}/{quantidade}/{busca}Produtos paginados com busca (_todos = sem filtro)
POST/produtosCadastra produto (+ configuração fiscal)
PUT/produtos/{ref}Atualiza um produto
DELETE/produtos/{ref}Exclui um produto

Health — /health (sem token)

MétodoCaminhoDescrição
GET/healthVerificação rápida (processo + pool). 200 / 503
GET/health/deepVerificação profunda (SELECT 1, latência do banco). 200 / 503
GET/health/poolMétricas do pool de conexões

Paginação

A v2 pagina por path: /{recurso}/paginacao/{pagina}/{quantidade}. O offset é calculado como (pagina × quantidade) − quantidade. A resposta é um array JSON dos objetos (sem envelope de total/página).