Antes que possa começar de fato os testes com a nossa API, é importante que conheça alguns processos básicos:
💡 #DicaDoBem: Atualmente, conseguimos testar as nossas API’s diretamente pelo site do Developer, porém, existem alguns programas que também podem realizar esse processo, como é o caso do Postman, Insomnia e o ThunderClient (uma extensão do VS Code)
Neste artigo, utilizaremos diretamente o site Developer Omie com uma APP KEY e APP SECRET padrão para teste. No entanto, se preferir, você poderá alterar essas credenciais para as suas próprias, executando assim os testes diretamente no seu aplicativo Omie
Iremos utilizar o método: IncluirPedCompra
Para criar o pedido de compra, temos que seguir o mínimo de requisitos obrigatórios, igual solicitado no sistema:
Fornecedor. "nCodFor";
Data de previsão de entrega. "dDtPrevisao";
Categoria. "cCodCateg";
Conta Corrente. "nCodCC"
⚠️ Para identificar o código dos seus registros, é preciso que utilize um método de listagem de cada um deles: |
Exemplo de requisição:
{
"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"
}
]
}
]
}
Você poderá consultar todos os parâmetros disponíveis para essa requisição, suas definições e limites de caracteres, por aqui:
Ao executar a requisição, temos o seguinte retorno:
{
"nCodPed": 7316417250,
"cCodIntPed": "INT001",
"cCodStatus": "0",
"cDescStatus": "Pedido de compra incluído com sucesso.",
"cNumero": "1"
}
Essa tag retornada “nCodPed” é muito importante, pois, é com ela que vamos consultar e fazer operações com nosso Pedido de Compra via API
E aqui está o nosso Pedido de Compra no sistema, com as informações que preenchemos na requisição 🤗 :
📌 Separamos alguns artigos interessantes para você:
