Postman / Insomnia Collection
A coleção oficial cobre os endpoints principais da API do FazNota, com requests prontas
e variáveis configuráveis (base, token, recibo, chave_nfe).
Download
- Postman Collection v2.1:
myse-nfe.postman_collection.json
A mesma coleção funciona no Insomnia (importa o formato Postman v2.1 nativamente).
Importar no Postman
-
Abra o Postman.
-
Clique em File → Import (ou Ctrl/Cmd + O).
-
Arraste o arquivo
myse-nfe.postman_collection.jsonou cole a URL acima. -
Configure as variáveis da coleção (clique na coleção → aba Variables):
Variável Valor sugerido basehttps://api.mysebr.com.br/nfemyse-v3/resttokenSeu Token (do Painel FazNota) recibo(vazio — preencha após emitir) chave_nfe(vazio — preencha quando tiver uma NFe) -
Clique em Save.
Importar no Insomnia
-
Abra o Insomnia.
-
Application → Preferences → Data → Import Data → From File.
-
Selecione o
myse-nfe.postman_collection.json. -
Configure o Environment com as variáveis acima.
Estrutura da coleção
API do FazNota — Nota Fiscal (v3)├── Status│ └── GET /health├── NFe│ ├── GET /nfe (listar com paginação)│ ├── GET /nfe/nota/:recibo│ ├── GET /nfe/nota/:recibo/completa│ ├── POST /nfe/emissao│ ├── PUT /nfe/:id (alterar)│ ├── POST /nfe/correcao│ └── POST /nfe/cancelamento├── NFCe│ ├── GET /nfce (listar com paginação)│ ├── GET /nfce/cupom/:recibo│ ├── POST /nfce/emissao│ └── POST /nfce/cancelamento├── NFSe│ ├── GET /nfse (com dataInicial)│ ├── POST /nfse/emissao│ └── POST /nfse/cancelamento├── Fornecedor│ ├── GET /nffornecedor│ └── POST /nffornecedor/reconhecimento├── Clientes│ ├── GET /clientes│ ├── GET /clientes/:doc│ ├── POST /clientes│ ├── PUT /clientes/:doc│ └── DELETE /clientes/:doc└── Produtos ├── GET /produtos └── POST /produtosFluxo recomendado para teste
-
Verifique a saúde da API
Execute
Status → GET /health. Deve retornar200 OKcom{"status":"ok",...}. -
Cadastre um produto (se não tiver)
Produtos → POST /produtos— ajuste o body conforme necessário. -
Emita uma NFCe (mais simples para teste)
NFCe → POST /nfce/emissao. Copie odata.reciboda resposta para a variávelrecibo. -
Consulte o cupom
NFCe → GET /nfce/cupom/:recibo. Vai usar automaticamente a variávelrecibo.Aguarde alguns segundos entre tentativas até receber
status: "004"(emitida). -
Pegue a chave
Da resposta do passo 4, copie
data.sefaz.chavepara a variávelchave_nfe. -
Teste cancelamento (se quiser)
NFCe → POST /nfce/cancelamento. Body já está preparado com{{chave_nfe}}.
Autenticação
A coleção já vem com API Key auth configurada no nível da coleção, adicionando automaticamente o header:
Authorization: Token {{token}}Em todos os requests, exceto GET /health (que sobrescreve para noauth).
Geração automática
A coleção é mantida sincronizada com o OpenAPI oficial. Se você preferir gerar sua própria coleção a partir do OpenAPI:
File → Import → URL: https://faznota.com.br/api/openapi/nota-fiscal.yaml
Postman gera automaticamente a coleção a partir do OpenAPI.
npm install -g openapi-to-postmanv2openapi2postmanv2 -s nota-fiscal.yaml -o minha-colecao.json -pApplication → Import → From URL → https://faznota.com.br/api/openapi/nota-fiscal.yaml
Próximos passos
- Quickstart — siga o tutorial passo a passo emitindo sua primeira NFCe.
- Referência completa — explore todos os endpoints com “Try it” embutido.
- Código de Exemplo — passe do Postman para integração de produção.