Agora no Bluesoft ERP, é possível consultar e filtrar convênios pelo novo atributo situacao (com os valores ATIVO, INATIVO e BLOQUEADO) nas APIs V1 e V2 de Convênios, além de contar com validação amigável e tratada de respostas HTTP 400 para valores inválidos e a depreciação formal do antigo campo status.

Objetivo: O objetivo desta melhoria é otimizar o processo de integração entre o ERP e sistemas terceiros, fornecendo consultas mais precisas por situação do convênio, respostas de erro claras e padronizadas para facilitar o diagnóstico de divergências e contratos de API organizados sem duplicidades.

Como Irá Funcionar a Partir de Agora?

A partir desta atualização, as integrações das APIs de Convênios contarão com os seguintes comportamentos e tratamentos:

  1. Filtro de Consulta por Situação (situacao):
    • Na rota GET /api/v2/convenios e GET /api/convenios, foi disponibilizado o parâmetro opcional de consulta situacao.
    • Os valores aceitos para filtragem são: ATIVO, BLOQUEADO e INATIVO.
    • O filtro por situacao pode ser combinado normalmente com os demais parâmetros de busca existentes (ex: convenioKey, participanteKey, documento, dataUltimaAlteracao e paginação).
    • Caso o parâmetro situacao não seja informado, a consulta retornará todos os convênios sem restrição de situação, mantendo o comportamento padrão.
  2. Validação e Tratamento de Erros de Requisição (HTTP 400):
    • Em operações de leitura e manutenção (GET, POST e PUT), caso o integrador envie um valor não previsto em situacao, a API retornará HTTP 400 com uma mensagem de erro funcional estruturada.
    • O retorno de erro indicará explicitamente o campo situacao e listará os valores aceitos (ATIVO, BLOQUEADO, INATIVO).
  3. Depreciação do Campo Legado (status):
    • O atributo status foi oficialmente marcado como Deprecated na documentação.
    • Ele continuará presente nas respostas de consulta para garantir a compatibilidade com sistemas legados, mas não deve mais ser utilizado em novos desenvolvimentos.

Observações Importantes!

  • Compatibilidade Retroativa: O atributo antigo status continua disponível no contrato atual da API enquanto estiver em período de depreciação, evitando a quebra de integrações legadas existentes.
  • Permissões e Autenticação: Permanecem inalteradas as exigências de autenticação e permissões de acesso (ex: Permissão 603 – Convênios Consultar).
  • Escopo das Operações: A validação e o tratamento do campo situacao aplicam-se a todas as operações das rotas V1 e V2 de Convênios (GET, POST e PUT).

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.

Disponível a partir da versão r372.01