As APIs do Omie permitem realizar diversas operações no ERP. Com isso, você consegue integrar diferentes aplicativos, expandindo ainda mais as possibilidades.
Descubra como importar um Cupom Fiscal (NFC-e) através da API! 🚀
Tópicos do Artigo:
Informações importantes
Antes de iniciar seus testes com a nossa API, é fundamental conhecer alguns processos básicos:
✅ Acessando a documentação: Consulte nossa documentação oficial para entender os endpoints disponíveis e seus respectivos parâmetros.
🔑 Chaves de Integração da API: Saiba como obter e utilizar suas credenciais de acesso para autenticar as requisições.
⚙️ Características e Recomendações: Fique por dentro das melhores práticas para otimizar sua experiência com a API da Omie.
🔐 Login no Portal: Para testar suas requisições no Portal do Desenvolvedor é necessário fazer login na plataforma com o mesmo e-mail e senha que você já usa no ERP. Fácil, né? 😉
🧪 Aplicativo Teste: Aprenda a criar um Aplicativo Teste gratuito e descubra, na prática, como utilizar nossas APIs e aproveitar ao máximo os nossos recursos.
💡 Dica Omie: Você pode testar nossas APIs diretamente no nosso Portal do Desenvolvedor. Além disso, ferramentas como Postman, Insomnia e ThunderClient (extensão do VS Code) também são ótimas opções para realizar testes.
Importando uma NFC-e por API
1) Para importar uma NFC-e será necessário utilizar o método "ImportarNFCe":
2) Você terá a seguinte requisição inicial:
{
"emiNome":
"GeradorNFe",
"emiVersao": "1.01.02",
"emiId": "PDV01",
"chNFe": "",
"nfceXml": "",
"nfceMd5": "",
"cAcaoCliente": "INCLUIR",
"idCliente": 0,
"idVendedor": 0,
"idProjeto": 0,
"idLocalEstoque": 0,
"cNaoMovEstoque": "N",
"cNaoGerarTitulo": "N",
"cIncluirProduto": "N"
}
3) Para preencher os dados na requisição, é necessário realizar dois processos para a conversão do XML:
(1) Retire os acentos do arquivo XML: ^; ~; ´; `
(2) Converter o arquivo XML, trocando os caracteres especiais, tais como:
&
== &<
== <>
== >'
== '"
== "|
== |Remover:
\
Sim... O "
;
" faz parte da conversão, ele deve ser informado.
4) Com o arquivo convertido, preencha a informação na tag nfceXml
.
5) Agora, é necessário gerar o MD5 do arquivo. Para isso, você pode utilizar qualquer site ou programa do seu interesse.
6) Com o hash do MD5 em mãos, informe na tag: nfceMd5
.
7) As demais tags são de preenchimento opcional: "cAcaoCliente", "idCliente", "idVendedor", "idProjeto", "idLocalEstoque", "cNaoMovEstoque", "cNaoGerarTitulo", "IncluirProduto"
8) Com todas as tags preenchidas, envie a requisição! Com tudo certo, você terá o seguinte retorno:
{
cCodStatus: "0",
cDesStatus: "NFC-e adicionada com sucesso! Elapsed time: XXX", idCupom: XXXX,
idImportacao: XXXX,
idLote: XXXX
}
9) E pronto! Sua NFC-e foi cadastrada com sucesso e estará disponível no sistema acessando o menu suspenso do módulo de "Vendas e NF-e", e clicando em "Painel de NFC-e, CF-e, SAT e Cupom Fiscal ECF":