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 uma NF-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 a NF-e via API
1) No Omie, você poderá importar a NF-e utilizando o método "ImportarNFe":
2) Você terá a seguinte requisição inicial:
{
"cAppNome": "GeradorNFe",
"cAppVersao": "1.01.02",
"cAppId": "NFe01",
"cChaveNFe": "",
"cXmlNFe": "",
"cMd5NFe": "",
"cOperacao": "11",
"cOrigem": "API",
"nCliente": 0,
"cCategoria": "1.01.02",
"nContaCorrente": 0,
"codigo_local_estoque": 0,
"lNaoMovEstoque": true,
"lNaoGerarTitulo": false,
"lNaoIncluirCliente": false,
"lNaoIncluirProduto": true
}
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 XML sem acentuações e devidamente convertido, preencha-o na sua requisição, na tag cXmlNFe.
5) A próxima etapa consiste em gerar o MD5 do arquivo XML convertido. Para isso, você tem a liberdade de utilizar um site ou programa de sua preferência.
6) Com o hash do MD5 em mãos, informe-o na tag: cMd5NFe.
7) As tags: cAppVersao, cAppId e cAppNome são de preenchimento livre. As demais tags são de preenchimento opcional: "cOperacao", "cOrigem", "nCliente", "cCategoria", "nContaCorrente", "codigo_local_estoque", "lNaoMovEstoque", "lNaoGerarTitulo", "lNaoIncluirCliente", "lNaoIncluirProduto".
8) Com todas as tags preenchidas, envie a requisição! Com tudo certo, você terá o seguinte retorno:
{
cChaveNFe: "3XXXXXXXXXXXX4",
cCodStatus: "0",
cDesStatus: "NF-e importada com sucesso!",
nIdImportacao: XXXXX,
nIdNFe: XXXXX
}
9) E pronto! Sua NF-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 NF-e":
📚 Artigos Relacionados
