Skip to content

Integrações

Conecte o iBPMS a um sistema externo, seja para buscar um dado no meio de um processo, avisar outro sistema quando algo muda, ou receber eventos de fora.

Há quatro caminhos, e eles diferem bastante em esforço. Comece decidindo qual se aplica antes de escrever qualquer configuração.

Escolha o caminho

Integração HTTP

Esforço de integração
Tipo de integração
Contrato de chamada que você declara
Personalização
Total sobre método, headers, body e outputs
  • Qualquer API REST
  • Versionamento imutável
  • Exige credencial no cofre

Webhook de entrada

Esforço de integração
Tipo de integração
Endpoint que recebe eventos de fora
Personalização
Você define o processo disparado
  • Sistema externo chama o iBPMS
  • Assinatura e idempotência

API externa

Esforço de integração
Tipo de integração
Outro sistema opera o iBPMS
Personalização
Limitada aos endpoints publicados
  • Autenticação por X-Api-Key
  • Cota mensal por plano

Se existe conector oficial para o fornecedor, use o conector. Ele já resolve autenticação, formato de chamada e tratamento de erro, e acompanha mudanças do fornecedor sem trabalho seu.

Integração HTTP Administração

Uma integração descreve uma chamada reutilizável: método, URL, autenticação, headers, parâmetros, body, inputs e outputs. O contrato existe para que esses detalhes não fiquem espalhados pelas regras.

  1. Defina o contrato e a finalidade da operação externa.
  2. Cadastre a credencial no cofre, nunca no contrato.
  3. Configure headers, query parameters e body usando inputs explícitos.
  4. Mapeie os campos relevantes da resposta para outputs.
  5. Teste com dados não sensíveis e valide timeout e erros.
  6. Publique uma versão antes de vinculá-la a regras em produção.

Credenciais Administração

Segredos não aparecem no contrato, em exemplos nem em logs. A integração referencia uma credencial administrada à parte, e o runtime aplica o valor apenas durante a execução.

Versionamento

Uma versão publicada é um contrato imutável para os fluxos que a usam. Faça alterações em uma versão nova e revise mudanças incompatíveis antes de publicar.

Usando a integração numa regra Motor de regras

Publicado o contrato, o nó HTTP do motor de regras passa a oferecer aquela integração. O nó guarda um snapshot da versão escolhida, então republicar a integração não altera regras que já rodavam.

Resiliência Motor de regras

  • escolha um timeout compatível com o serviço;
  • limite retries e use backoff;
  • repita automaticamente apenas operações seguras ou idempotentes;
  • mapeie erros previsíveis para caminhos explícitos;
  • nunca registre tokens ou dados pessoais desnecessários.

Opcional: assinar as chamadas de saída Motor de regras

Quando o sistema receptor precisa provar que a chamada veio do iBPMS, o nó HTTP assina o corpo com HMAC e envia timestamp, o que também protege contra replay.

Teste sua integração

  1. Execute a regra em modo de teste com dados não sensíveis.
  2. Confira na área de Operações o trace da execução e a resposta recebida.
  3. Verifique se os outputs mapeados chegaram ao contexto com o tipo esperado.
  4. Force um erro (URL inválida, credencial errada) e confirme que o caminho de erro é o que você espera.

Veja também

Documentação pública do iBPMS.