Pular para o conteúdo

Postman / Insomnia Collection

A coleção oficial traz 81 requests prontas, em 13 pastas (Status, NFe, NFCe, NFSe, Classificação fiscal, Rotinas, Certificado, Fornecedor, Clientes, Produtos, CIOT, RENAVE e Relatórios), e variáveis configuráveis (base, token, recibo, chave_nfe, protocolo, id_rotina).

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)
    protocolo(vazio — preencha após POST /xml/solicitacao)
    id_rotina(vazio — preencha após criar uma rotina)
  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

Myse API — Nota Fiscal (v3)
├── Status
│ ├── GET /health
│ ├── GET /health/deep
│ └── GET /health/pool
├── NFe
│ ├── GET /nfe (listar com paginação)
│ ├── GET /nfe/paginacao/:pagina/:quantidade (legado)
│ ├── GET /nfe/nota/:recibo
│ ├── GET /nfe/nota/:recibo/completa
│ ├── POST /nfe/emissao
│ ├── PUT /nfe/:id (alterar)
│ ├── POST /nfe/correcao
│ ├── GET /nfe/correcao/:recibo
│ ├── POST /nfe/cancelamento
│ ├── GET /nfe/cancelamento/:recibo
│ ├── POST /nfe/inutilizacao
│ └── GET /nfe/inutilizacao/:recibo
├── NFCe
│ ├── GET /nfce (listar com paginação)
│ ├── GET /nfce/paginacao/:pagina/:quantidade (legado)
│ ├── GET /nfce/cupom/:recibo
│ ├── GET /nfce/cupom/:recibo/completa
│ ├── POST /nfce/emissao
│ ├── PUT /nfce/:id (alterar)
│ ├── POST /nfce/cancelamento
│ ├── GET /nfce/cancelamento/:recibo
│ ├── POST /nfce/inutilizacao
│ └── GET /nfce/inutilizacao/:recibo
├── NFSe
│ ├── GET /nfse (com dataInicial)
│ ├── GET /nfse/nota/:recibo
│ ├── POST /nfse/emissao
│ ├── PUT /nfse/:id (alterar)
│ ├── POST /nfse/cancelamento
│ └── POST /nfse/cancelar (alias legado)
├── Classificação fiscal
│ ├── POST /classificacao-fiscal
│ └── POST /classificacao-fiscal/lote
├── Rotinas
│ ├── GET /rotinas
│ ├── GET /rotinas/modelos
│ ├── GET /rotinas/clientes
│ ├── GET /rotinas/servicos
│ ├── POST /rotinas/validar
│ ├── POST /rotinas
│ ├── GET /rotinas/:id
│ ├── PUT /rotinas/:id
│ ├── DELETE /rotinas/:id
│ ├── GET /rotinas/:id/execucoes
│ ├── POST /rotinas/:id/pausar
│ ├── POST /rotinas/:id/retomar
│ ├── POST /rotinas/:id/emitir-agora
│ ├── GET /rotinas/:id/extras
│ ├── PUT /rotinas/:id/extras/:competencia
│ └── DELETE /rotinas/:id/extras/:competencia
├── Certificado
│ ├── GET /certificado
│ └── POST /certificado/a1
├── Fornecedor
│ ├── GET /nffornecedor
│ ├── GET /nffornecedor/:recibo
│ └── POST /nffornecedor/reconhecimento
├── Clientes
│ ├── GET /clientes
│ ├── GET /clientes/:doc
│ ├── GET /clientes/busca/:nome
│ ├── POST /clientes
│ ├── PUT /clientes/:doc
│ └── DELETE /clientes/:doc
├── Produtos
│ ├── GET /produtos
│ ├── GET /produtos/:ref
│ ├── GET /produtos/nome/:nome
│ ├── GET /produtos/paginacao/:pagina/:quantidade/:busca (legado)
│ ├── POST /produtos
│ ├── PUT /produtos/:ref
│ └── DELETE /produtos/:ref
├── CIOT
│ ├── POST /ciot/emissao
│ ├── POST /ciot/cancelamento
│ ├── POST /ciot/retificacao
│ ├── POST /ciot/encerramento
│ └── GET /ciot/:recibo
├── RENAVE
│ ├── POST /renave/nota-fiscal/entrada
│ ├── POST /renave/nota-fiscal/saida
│ ├── POST /renave/estoque/entrada-veiculo-proprio
│ ├── POST /renave/estoque/cancelamento-entrada
│ ├── POST /renave/estoque/cancelamento-saida
│ └── GET /renave/:recibo
└── Relatórios
├── GET /resumo
├── POST /xml/solicitacao
└── GET /xml/solicitacao/:protocolo

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 os da pasta Status (GET /health, /health/deep e /health/pool), que sobrescrevem 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