Pular para o conteúdo principal

20/07/2026

API de Extensões — Scripts​

Conteúdo:

Para otimizar cenários de integração, geração de relatórios sob demanda e execução controlada de rotinas, disponibilizamos APIs para a área de Extensões. O objetivo é permitir que sistemas externos automatizem consultas e execuções sem depender da operação manual por meio da interface web.

Agora, parceiros e integrações externas podem realizar consultas e execuções programáticas de relatórios e scripts informando os parâmetros esperados. As APIs seguem um padrão único de arquitetura entre as verticais da plataforma, permitindo o reaproveitamento de código em diferentes produtos.

Com essas APIs, é possível:

  • consultar os parâmetros necessários para executar um relatório;
  • executar relatórios informando os parâmetros esperados;
  • consultar os parâmetros necessários para executar um script;
  • executar scripts informando os parâmetros esperados;
  • enviar arquivos quando a execução exigir um parâmetro de upload;
  • acompanhar o processamento por meio do protocoloExecucao;
  • consultar posteriormente o resultado da execução.

Atualmente, temos as APIs disponíveis para as seguintes verticais:

  • Almoxarifado
  • Compras
  • Contábil
  • Contratos
  • Patrimônio
  • Planejamento
  • Prestação de Contas
  • Recursos Humanos
  • Tributos

novidade

As APIs seguem o mesmo padrão entre as verticais, facilitando o reaproveitamento da integração para diferentes produtos.

Fluxo de consumo da API​

O fluxo de consumo da API foi desenhado em 6 etapas sequenciais:

  1. Consulte os parâmetros: chame a API para identificar quais parâmetros o relatório ou script exige para ser executado.
  2. Monte o objeto de envio: estruture o objeto parametros utilizando o valor exato retornado no campo nome da API.
  3. Envie os arquivos de upload (se houver): caso exista algum parâmetro com a propriedade dadosUpload, realize o upload do arquivo diretamente na URL pré-assinada informada no atributo dadosUpload.url.
  4. Dispare a execução: execute o relatório ou script enviando o objeto parametros devidamente preenchido.
  5. Armazene o protocolo: guarde o identificador retornado no campo protocoloExecucao.
  6. Consulte o resultado: use o protocolo salvo para acompanhar o status e coletar o resultado final da execução.

Consulta do resultado​

Como as execuções de relatórios e scripts são assíncronas, o processamento deve ser monitorado por meio do protocoloExecucao.

A consulta do status e o resgate do resultado podem ser feitos diretamente na URL do serviço de Consulta de Execuções:

https://consulta-execucoes.plataforma.betha.cloud/#/

Também é possível acessar diretamente o resultado informando o protocolo na URL:

https://consulta-execucoes.plataforma.betha.cloud/#/{protocoloExecucao}/resultado
info

As execuções de relatórios e scripts são assíncronas — utilize o protocoloExecucao para acompanhar o status até a finalização.

Essas APIs ampliam as possibilidades de automação para cenários de integração, rotinas operacionais, geração de relatórios sob demanda e execução controlada de scripts nas verticais atendidas.