NS NFe.exe

Introdução

Esta página apresenta trechos de códigos de uma aplicação em VB.NET que foi desenvolvida para consumir as funcionalidades da NS NF-e API. Você pode realizar o download do exemplo clicando no link abaixo:

Funcionamento da estrutura

Para que você possa utilizar o projeto de exemplo, você deve compilá-lo para gerar o executável, pois ele será utilizado para comunicar com a API. Através de sua aplicação, você irá “rodar” o executável passando o nome da função que deseja executar e o restante dos parâmetros necessários. A aplicação possui as classes NFeAPI.vb e Principal.vb; confira o objetivo de cada uma:

NFeAPI.vb: contém todas as funções de comunicação com a API.

Principal.vb: é responsável por ler os parâmetros passados junto com a chamada do executável e realizar a chamada da função desejada (exemplo: emitirNFe, cancelarNFe, etc).

Integrando ao sistema

Para gerar o executável e comunicar com a API, você precisa realizar os seguintes passos:

1. Instale o Visual Studio Community (é gratuito) clicando aqui: Visual Studio;
2. Extraia o conteúdo da pasta que você baixou anteriormente e abra o projeto no Visual Studio (duplo clique sobre o arquivo NFeAPI.sln);
3. Compile o código apertando F5 (ou clicando no botão Run da IDE).
4. Acesse a pasta NFeAPI > bin > Debug e copie os seguintes arquivos:
   1. NFeAPI.exe;
   2. Newtonsoft.dll;
   3. Newtonsoft.xml.
5. Cole os arquivos na pasta de sua aplicação (de preferência, na mesma pasta do executável de sua aplicação.

Pronto! Agora, você já pode consumir a NS NF-e API através do seu sistema. Confira abaixo sobre realizar uma emissão completa.

Realizando uma emissão

Para realizar uma emissão completa, você poderá utilizar a função emitirNFeSincrono. Veja abaixo sobre os parâmetros necessários, e um exemplo de chamada do método.

Parâmetros

Exemplo de chamada

Após ter todos os parâmetros listados acima, você deverá fazer a chamada do executável. Veja o código de exemplo abaixo:

Exemplo de chamada emitirNFeSincrono

ShellExecute(0, "Open", "NFeAPI.exe", "emitirNFeSincrono SEU_TOKEN C:/nota_001.txt txt 07364617000135 XP 2 C:/notas true 001", 0, 1)

Acima foi utilizado o comando ShellExecute mas você pode utilizar outro comando de sua preferência.

 
A função emitirNFeSincrono fará o envio, a consulta e download do documento, utilizando as funções emitirNFe, consultarStatusProcessamento e downloadNFeAndSave, presentes na classe NFeAPI.bas. Por isso, o retorno será um JSON com os principais campos retornados pelos métodos citados anteriormente.

O retorno da chamada acima ficaria assim: ./respostas/emitirNFeSincrono_001.json

No exemplo abaixo, veja como tratar o retorno da função emitirNFeSincrono:

Exemplo de tratamento do retorno

O JSON retornado pelo método terá os seguintes campos: statusEnvio, statusConsulta, statusDownload, cStat, chNFe, nProt, motivo, nsNRec, erros. Veja o exemplo abaixo:Retorno emitirNFeSincrono

{"statusEnvio": "200","statusConsulta": "200","statusDownload": "200","cStat": "100","chNFe": "43181007364617000135550000000119741004621864","nProt": "143180007036833","motivo": "Autorizado o uso da NF-e","nsNRec": "313022","erros": ""}

Confira a lógica para tratamento do retorno, e aplique-a na sua linguagem:Código de exemplo de tratamento do retorno

'Primeiramente, você deve ler os campos do json de retorno, através do seu sistema.'Agora que você já leu os dados, é aconselhável que faça o salvamento de todos'eles no seu banco de dados antes de prosseguir para o teste abaixo. 'Testa se houve sucesso na emissãoSe (statusEnvio = 200) Ou (statusEnvio = -6) Então'Testa se houve sucesso na consultaSe (statusConsulta = 200) Então'Testa se a nota foi autorizadaSe (cStat = 100) Ou (cStat = 150) Então'Aqui dentro você pode realizar procedimentos como desabilitar o botão de emitir, etcMostrarMensagem (motivo) 'Testa se o download teve problemasSe (statusDownload != 200) EntãoMostrarMensagem (motivo)Fim SeSenão'Aqui você pode mostrar alguma solução para o parceiro ou exibir opção de editar a notaMostrarMensagem (motivo)Fim Se'Caso tenha dado erro na consultaSenão'Aqui você pode mostrar uma mensagem ao usuárioMostrarMensagem (motivo + Chr(13) + erros)Fim SeSenão'Aqui você pode exibir para o usuário o erro que ocorreu no envioMostrarMensagem (motivo + Chr(13) + erros)Fim Se

Demais funcionalidades

No módulo NFeAPI, você pode encontrar também as seguintes funcionalidades: