As APIs do Omie foram desenvolvidas para oferecer flexibilidade e eficiência na integração de sistemas e automatização de processos, permitindo que você conecte suas soluções diretamente ao Omie.
Aqui, vamos te mostrar o passo a passo para cadastrar os seus Pedidos de Compra através das nossas APIs.
Preparado para simplificar sua gestão e otimizar seu tempo? Então, vamos lá! 🚀
Informações Importantes sobre as APIs Omie
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 nosso 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.
Cadastrando um Pedido de Compra via API
1) No Portal do Desenvolvedor, acesse a lista de APIs:
2) No tópico "Compras, Estoque e Produção" (1), selecione a opção "Pedidos de Compra" (2):
3) Para cadastrar Pedidos de Compra, é preciso utilizar o método IncluirPedCompra:
4) Após selecionar o método IncluirPedCompra, você poderá consultar todos os parâmetros disponíveis:
5) Para realizar um teste rápido com os parâmetros básicos, basta clicar em "Teste agora mesmo":
💡 Entendendo os parâmetros
💡 Entendendo os parâmetros
Por aqui, você encontrará uma lista dos parâmetros disponíveis para sua requisição, incluindo:
Nome – Identifica a variável dentro da API.
Tipo de dado – Indica o formato esperado (integer, string, decimal, etc.)
Descrição – Explica a finalidade do parâmetro e como utilizá-lo.
6) Para realizar um teste pelo Developer - Portal do Desenvolvedor, é preciso realizar o login no Omie.
7) Após realizar o login, você será direcionado para a tela de testes do Developer, onde poderá configurar e enviar requisições para a API. Veja como cada campo funciona:
(1) Endpoint: O Omie preencherá automaticamente este campo com:
🔗
https://app.omie.com.br/api/v1/produtos/pedidocompra/(2) Aplicativo ou Chave de Acesso: Aqui, você verá uma lista dos aplicativos aos quais seu e-mail tem acesso. Basta selecionar o desejado, e os campos App Key e App Secret serão preenchidos automaticamente.
💡 Caso precise testar um aplicativo que não aparece na lista, selecione "O aplicativo que eu quero não está na lista" e insira manualmente suas credenciais.
(3) Call: O Omie definirá automaticamente o tipo de chamada como IncluirCliente.
(4) Conteúdo: Este é o campo onde você configurará sua requisição, inserindo os dados necessários para cadastrar um Cliente ou Fornecedor.
8) A seguir, demonstramos um exemplo de requisição para cadastro de Pedidos de Compra:
{
"call": "IncluirPedCompra",
"app_key": "XXXXXXXXXXXXXX",
"app_secret": "XXXXXXXXXXXXXXXXX ",
"param": [
{
"cabecalho_incluir": {
"cCodIntPed": "INT001",
"dDtPrevisao": "20/04/2023",
"cCodParc": "999",
"cCodCateg": "2.01.01",
"nQtdeParc": 1,
"nCodFor": "7311798906",
"cContato": "",
"nCodCC": "7311798895",
"cNumPedido": "66815",
"cObs": "Pedido incluido via API",
"cObsInt": "Pedido Cadastrado via API"
},
"frete_incluir": {
"nCodTransp": 0,
"cCodIntTransp": "",
"cTpFrete": "9",
"cPlaca": "XXX-999",
"cUF": "SP",
"nQtdVol": 5,
"cEspVol": "",
"cMarVol": "",
"cNumVol": "",
"nPesoLiq": 0,
"nPesoBruto": 0,
"nValFrete": 0,
"nValSeguro": 0,
"cLacre": "",
"nValOutras": 0
},
"departamentos_incluir": [
{
"cCodDepto": "7315696762",
"nPerc": 100
}
],
"produtos_incluir": [
{
"cCodIntItem": "ITEM001",
"nCodProd": "7311799058",
"cNCM": "9504.10.99",
"cUnidade": "UN",
"nQtde": 5,
"nValUnit": 200,
"nDesconto": 0,
"nValorIcms": 360,
"nValorSt": 0,
"nValorIpi": 20,
"nValorPis": 33,
"nValorCofins": 152,
"cObs": "Inclusão por API",
"cMkpAtuPv": "N",
"cMkpAtuSm": "N",
"codigo_local_estoque": "7311798902",
"cCodCateg": "2.01.01"
}
]
}
]
}
9) Ao executar a requisição com todos os parâmetros corretamente informados, você receberá uma resposta positiva contendo o código do Pedido de Compra cadastrado.
Esse identificador, retornado na tag “nCodPed”, é fundamental, pois serve como referência para consultas e para a realização de operações via API.
{
"nCodPed": 7316417250,
"cCodIntPed": "INT001",
"cCodStatus": "0",
"cDescStatus": "Pedido de compra incluído com sucesso.",
"cNumero": "1"
}
10) No Omie ERP, o Pedido de Compra estará cadastrado:
Com esse artigo, você poderá consultar com detalhes os Pedidos de Compra cadastrados:
📚 Artigos Relacionados
