Antes que possa começar de fato os testes com a nossa API, é importante conhecer 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) |
Para o nosso teste, vamos utilizar diretamente o Developer. Assim como, vamos utilizar o APP KEY e o APP SECRET padrões, mas se preferir, pode alterar para o seu 😉
Nesse artigo, temos:
Listando os Clientes/Fornecedores
Para esse processo utilizaremos o seguinte método: ListarClientes
Aqui no exemplo, utilizaremos a requisição padrão, conforme abaixo:
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N"
}
Mas se desejar, pode ser informado algum parâmetro a mais conforme disponível na requisição:
Para realizar o teste, clique em "Executar":
No lado direito você terá disponível algumas informações bem importantes:
2) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos;
3) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso
4) Corpo: é nessa parte que serão exibidos todos os retornos da requisição enviada
Dois campos importantes que devem ser guardados são:
"codigo_cliente_integracao":
"codigo_cliente_omie"
Pois é por eles que vamos localizar os clientes nos demais métodos da API
Listando as Categorias
Para esse processo utilizaremos o seguinte método: ListarCategorias
Aqui no exemplo, utilizaremos a requisição padrão, conforme abaixo:
{
"pagina": 1,
"registros_por_pagina": 50
}
Mas se quiser, você pode adicionar mais parâmetros disponíveis aqui:
Para realizar o teste, clique em "Executar":
No lado direito você terá disponível algumas informações bem importantes:
2) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos;
3) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso
4) Corpo: é nessa parte que serão exibidos todos os retornos da requisição enviada
O campo mais importante que deve ser guardado é:
"codigo"
Pois é por ele que vamos nos conectar com os demais métodos da API
Listando as Contas Correntes
Para esse processo utilizaremos o seguinte método: ListarContasCorrentes
Aqui no exemplo, utilizaremos a requisição padrão, conforme abaixo:
{
"pagina": 1,
"registros_por_pagina": 100,
"apenas_importado_api": "N"
}
Mas se quiser, você pode adicionar mais parâmetros disponíveis aqui:
Para realizar o teste, clique em "Executar":
No lado direito você terá disponível algumas informações bem importantes:
2) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos;
3) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso
4) Corpo: é nessa parte que serão exibidos todos os retornos da requisição enviada
O campo mais importante que deve ser guardado é:
"nCodCC"
Pois é por ele que vamos nos conectar com os demais métodos da API
Listando os Produtos
Para esse processo utilizaremos o seguinte método: ListarProdutos
Aqui no exemplo, utilizaremos a requisição padrão, conforme abaixo:
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N",
"filtrar_apenas_omiepdv": "N"
}
Mas se desejar, pode ser informado algum parâmetro a mais conforme disponível na requisição:
Para realizar o teste, clique em "Executar":
No lado direito você terá disponível algumas informações bem importantes:
2) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos;
3) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso
4) Corpo: é nessa parte que serão exibidos todos os retornos da requisição enviada
Dois campos importantes que devem ser guardados são:
"codigo_produto"
"codigo_produto_integracao"
Pois é por eles que vamos localizar os clientes nos demais métodos da API
Listando os Serviços
Para esse processo utilizaremos o seguinte método: ListarCadastroServico
Aqui no exemplo, utilizaremos a requisição padrão, conforme abaixo:
{
"nPagina": 1,
"nRegPorPagina": 20
}
Mas se desejar, pode ser informado algum parâmetro a mais conforme disponível na requisição:
Para realizar o teste, clique em "Executar":
No lado direito você terá disponível algumas informações bem importantes:
2) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos;
3) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso
4) Corpo: é nessa parte que serão exibidos todos os retornos da requisição enviada
Dois campos importantes que devem ser guardados são:
"cCodIntServ"
"nCodServ"
Pois é por eles que vamos localizar os clientes nos demais métodos da API
Listando as Contas a Receber
Para esse processo utilizaremo o seguinte método: ListarContasReceber
Aqui no exemplo, utilizaremos a requisição padrão, conforme abaixo:
{
"pagina": 1,
"registros_por_pagina": 20,
"apenas_importado_api": "N"
}
Mas se desejar, pode ser informado algum parâmetro a mais conforme disponível na requisição:
Para realizar o teste, clique em "Executar":
No lado direito você terá disponível algumas informações bem importantes:
2) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos;
3) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso
4) Corpo: é nessa parte que serão exibidos todos os retornos da requisição enviada
Dois campos importantes que devem ser guardados são:
"codigo_lancamento_integracao"
"codigo_lancamento_omie"
Pois é por eles que vamos localizar os clientes nos demais métodos da API
Listando as Contas a Pagar
Para esse processo utilizaremo o seguinte método: ListarContasPagar
Aqui no exemplo, utilizaremos a requisição padrão, conforme abaixo:
{
"pagina": 1,
"registros_por_pagina": 20,
"apenas_importado_api": "N"
}
Mas se desejar, pode ser informado algum parâmetro a mais conforme disponível na requisição:
Para realizar o teste, clique em "Executar":
No lado direito você terá disponível algumas informações bem importantes:
2) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos;
3) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso
4) Corpo: é nessa parte que serão exibidos todos os retornos da requisição enviada
Dois campos importantes que devem ser guardados são:
"codigo_lancamento_integracao"
"codigo_lancamento_omie"
Pois é por eles que vamos localizar os clientes nos demais métodos da API
📌 Separamos alguns artigos relacionados que podem te ajudar bastante:
