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) |
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:
Obtendo os dados necessários
Para realizar a baixa da conta a receber será necessário já ter alguns dados para enviar como parâmetros nas requisições
Para a requisição padrão, é necessário já ter:
Código do Lançamento que deseja realizar a baixar:
Código da Conta Corrente em que deseja registrar o recebimento:
Baixando a conta a receber
Para esse processo utilizaremos o seguinte método: LancarRecebimento
Aqui no exemplo, utilizaremos a requisição padrão, conforme abaixo:
{
"codigo_lancamento": 0,
"codigo_baixa": 7894,
"codigo_conta_corrente": 0,
"valor": 0,
"data": "14/08/2023",
"observacao": "Exemplo - Baixando uma conta a receber"
}📌 A tag "codigo_baixa" deve ser informado manualmente e será único para essa baixa específica, como uma espécie de identificador
Mas se quiser, você pode adicionar mais parâmetros disponíveis aqui:
📌 Caso queira adicionar algum desconto na conta a receber, é necessário informar a tag "desconto" e preencher o valor. Lembrando que o desconto pode ser total ou parcial
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.
Prontinho! Sua conta a receber foi baixada com sucesso!
📌 Separamos alguns artigos relacionados que podem te ajudar bastante:
