Pular para o conteúdo

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

A mesma coleção funciona no Insomnia (importa o formato Postman v2.1 nativamente).

Importar no Postman

  1. Abra o Postman.

  2. Clique em File → Import (ou Ctrl/Cmd + O).

  3. Arraste o arquivo myse-nfe.postman_collection.json ou cole a URL acima.

  4. Configure as variáveis da coleção (clique na coleção → aba Variables):

    VariávelValor sugerido
    basehttps://api.mysebr.com.br/nfemyse-v3/rest
    tokenSeu Token (do Painel FazNota)
    recibo(vazio — preencha após emitir)
    chave_nfe(vazio — preencha quando tiver uma NFe)
  5. Clique em Save.

Importar no Insomnia

  1. Abra o Insomnia.

  2. Application → Preferences → Data → Import Data → From File.

  3. Selecione o myse-nfe.postman_collection.json.

  4. 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 /produtos

Fluxo recomendado para teste

  1. Verifique a saúde da API

    Execute Status → GET /health. Deve retornar 200 OK com {"status":"ok",...}.

  2. Cadastre um produto (se não tiver)

    Produtos → POST /produtos — ajuste o body conforme necessário.

  3. Emita uma NFCe (mais simples para teste)

    NFCe → POST /nfce/emissao. Copie o data.recibo da resposta para a variável recibo.

  4. Consulte o cupom

    NFCe → GET /nfce/cupom/:recibo. Vai usar automaticamente a variável recibo.

    Aguarde alguns segundos entre tentativas até receber status: "004" (emitida).

  5. Pegue a chave

    Da resposta do passo 4, copie data.sefaz.chave para a variável chave_nfe.

  6. 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.

Próximos passos