Agora no Bluesoft ERP, é possível consultar saldo e realizar empenho em convênios por cartão próprio de convenio via API
O objetivo central desta melhoria é permitir o uso de cartão de convênio no Ponto de Venda (PDV) e integrar a gestão desse fluxo via API com sistemas externos, visando agilizar o processo de vendas e otimizar a gestão de convênios.
Foi criado um novo campo na API de integração de cupons fiscais para permitir que seja informado na venda qual cartão de convênio foi utilizado no PDV.
1. Alteração em Endpoint Existente (GET /api/convenios)
O campo numeroCartao nos retornos das APIs de busca de convênio (tanto GET /api/convenios quanto GET /api/convenios/{convenioKey}) foi ajustado.
• Regra de Alteração: O numeroCartao agora retorna o número completo com 16 dígitos.
Foram criados novos endpoints para suportar as operações de convênio no PDV através do número do cartão do conveniado.
1. Consulta de Limite de Convênio por Cartão
Esta funcionalidade permite consultar o limite e o saldo disponível de um convênio utilizando o número do cartão.
| Objetivo | Consultar limite e saldo disponível através do número do cartão. |
| Método | GET. |
| Endpoint | /api/clientes/limite-convenio/{numeroCartao}/limite. |
| Validação | O cartão deve estar em status Ativo. Caso contrário (Ex: Inativo, Pendente), a API retorna erro 400 com a mensagem: “O cartão consultado não esta ativo, verifique o cadastro”. |
2. Validação de Senha do Cartão de Convênio
Este endpoint foi criado para validar a senha do cliente usando o número do cartão.
| Objetivo | Validar a senha do cartão de convênio. |
| Método | POST. |
| Endpoint | /api/clientes/convenio/{numeroCartao}/validar-senha. |
| Corpo da Requisição (JSON) | cpfCnpj, codigoConvenio, senha, checkSum. |
| Regra para o campo checkSum | O campo checkSum deve ser validado utilizando a regra MD5 |
| Regra para o campo senha | O campo senha deve ser validado utilizando a regra base64 |
3. Gestão de Empenho de Valor (Empenho e Cancelamento)
Foram criados dois endpoints para realizar o empenho (reserva de valor) e o cancelamento do empenho, utilizando o número do cartão.
| —————– | Realização do Empenho | Cancelamento do Empenho |
| Objetivo | Realizar o empenho do valor a ser utilizado na compra. | Realizar o cancelamento do empenho. |
| Método | POST. | POST. |
| Endpoint | /api/clientes/{numeroCartao}/empenho-convenio. | /api/clientes/{numeroCartao}/cancelar-empenho-convenio. |
| Corpo da Requisição | cpfCnpj, codigoConvenio, valor. | cpfCnpj, codigoConvenio, valor. |
| Validação | Se o cartão não estiver Ativo, retorna erro. | Se o cartão não estiver Ativo, retorna erro. |
Para conhecer mais sobre como é a utilização dessa ferramenta, clique aqui.
Para saber mais sobre a utilização das APIs do ERP, clique aqui.