Agora no Bluesoft ERP, é possível obter o identificador único do convênio (convenioKey) diretamente na consulta do monitoramento de requisições assíncronas, logo após a conclusão do processamento via API

O objetivo desta melhoria é otimizar a integração para desenvolvedores e parceiros, eliminando a necessidade de realizar chamadas adicionais para descobrir o código interno de um convênio recém-criado.

Com esta atualização, o objeto de resposta do monitoramento foi enriquecido para fornecer todos os dados necessários para o próximo passo da integração.

  • Retorno de Sucesso: Ao atingir o status CONCLUIDO, o JSON de resposta incluirá o campo convenioKey dentro do objeto de resultado.
  • Identificador Único: O valor retornado corresponde ao UUID ou Long gerado pelo banco de dados do ERP.
  • Endpoint de Consulta: A melhoria está disponível no endpoint:
    • URL: /api/monitoramento/async/{requestId}
    • Método: GET

Exemplo de Retorno (Sucesso):

JSON

[
    {
        "requestId": "08e97488-9985-46b0-9024-e96897b89d01",
        "status": "DONE",
        "startTime": "2026-03-09T10:00:57.04",
        "lastUpdate": "2026-03-09T10:00:57.04",
        "actions": [
            {
                "description": "'Convenio' com {group id=api-async, id=69aec488021ef12875b63055}",
                "steps": [
                    "Executando",
                    "Convênio criado com sucesso. convenioKey: 61594",
                    "Finalizado"
                ]
            }
        ],
        "elapsedTime": 0
    }
]

Observações Importantes!

  • Tratamento de Erros: Caso ocorra qualquer falha na criação do convênio (status ERRO), o campo convenioKey será omitido, mantendo-se apenas a lista detalhada de erros para análise.
  • Compatibilidade: A alteração foi desenhada para não quebrar integrações existentes, apenas adicionando o novo campo ao JSON de resposta.
  • Continuidade do Fluxo: A convenioKey retornada é exatamente a mesma que deve ser utilizada nos endpoints de edição, como o PUT /v2/convenios/{convenioKey}.

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 r367.01