Como instalar e configurar o Postman para utilizar a API eNotas

O Postman é uma ferramenta que dá suporte à documentação das requisições feitas pela API e Schemas. Ele possui ambiente para a documentação, execução de testes de APIs e requisições em geral.

Ao utilizar o Postman, você passará a trabalhar com APIs de modo mais eficiente, construindo solicitações rápidas e, ainda, poderá guardá-las para uso posterior, além de conseguir analisar as respostas enviadas pela API. Será possível reduzir drasticamente o tempo necessário para testar e desenvolver APIs.
 

 

 

• Baixe a versão mais recente no site oficial.

• Depois de baixado, execute o arquivo em sua maquina para dar inicio a instalação do programa.

• Após esse passo, a instalação ocorrerá de forma forma rápida e automática, não aparecerá nenhuma validação para prosseguimento do processo de instalação.

 

 

 

Embora não seja necessário criar uma conta para utilizar a maioria das funções do Postman, recomendamos que uma conta seja criada para que você possa armazenar e consultar o seu histórico de atualizações, além de conseguir acessar suas collections e seus envirometns de onde estiver. 

 

• Ao abrir o Postman pela primeira vez um popup solicitando login será exibido. Crie sua conta, faça login ou ignore este passo. 

 

• Faça o download das collections abaixo:

 

1. NFS-e - API V1

2. NF-e/NFC-e - API V2

 

• Clique no ícone de Collections e depois clique em "Import", como mostrado no print abaixo:

 

 

• No popup que abrir clique em "Upload files":

 

 

 

• Selecione os dois arquivos que você baixou anteriormente e clique em "Abrir":

 

 

• Em seguida, clique em "Import":

 

 

• Ao finalizar o processo, os endpoints devem aparecer do lado esquerdo do Postman:

 

 

• Em cada endpoint disponível na collection, a aba Headers estará parametrizada para o envio da API Key de autenticação.



• Substitua o campo {{apiKey}} pela API Key de sua empresa. 



Apague o desenho de setinha e qualquer espaço que tenha no campo onde a API Key está preenchida!

 

⚠️ IMPORTANTE! A API Key é um dado sensível que tem o objetivo de identificar a sua empresa na eNotas. Ela pode ser encontrada no painel do Gateway, na aba API Key:

  

Caso tenha ficado com alguma dúvida ou precise de auxílio, nosso suporte está à disposição! :D