Fluxos de integração

O SDK expõe quatro flows públicos. Eles cobrem os cenários principais de sincronização e transferência de dados.

1. NoDeltaIntegrationFlow

Use quando a automação apenas coleta dados de uma origem e envia para um destino, sem comparar estado anterior.

É o flow mais direto para webhooks, exportações simples e integrações orientadas a evento.

Métodos centrais:

• loadSourceSystemData()

• sendData()

• defineMetadata()

2. NoDeltaBatchIntegrationFlow

Use quando o comportamento é igual ao fluxo no-delta, mas o envio deve ser feito em lotes.

Esse flow costuma ganhar relevância quando o destino oferece endpoint bulk ou quando o custo por operação individual é alto.

Método adicional:

• batchSendData()

3. DeltaIntegrationFlow

Use quando você precisa comparar origem e destino para identificar:

• inserts;

• updates;

• deletes.

Esse costuma ser o flow dominante em sincronizações entre sistemas mestres.

Métodos centrais:

• loadSourceSystemData()

• loadTargetSystemData()

• insertAction()

• updateAction()

• deleteAction()

• defineMetadata()

4. BatchDeltaIntegrationFlow

Use quando o modelo delta precisa operar com maior volume e chamadas em lote.

Ele combina reconciliação de estado com ações agrupadas no destino.

Métodos adicionais:

• batchInsertAction()

• batchUpdateAction()

• batchDeleteAction()

Key fields e delta fields

Nos fluxos delta, você define:

• key fields para identificar unicamente um registro;

• delta fields para detectar alterações relevantes.

Na prática, keyFields define identidade e deltaFields define o que conta como mudança relevante.

Persistência de estado

Os fluxos delta usam os recursos internos do SDK para persistir o estado anterior da execução. Isso permite comparar snapshots e reduzir lógica manual dentro da integração.

Metadados

defineMetadata() controla como os dados aparecerão no monitoramento.

Boas práticas:

• use labels compreensíveis para operação;

• não use Action, Status ou Message como fieldLabel;

• escolha o fieldType correto para melhorar filtros e visualização.

Exemplos de decisão

• integração de webhook para gravar dados em banco: NoDeltaIntegrationFlow;

• exportação analítica com lotes: NoDeltaBatchIntegrationFlow;

• sincronização de colaboradores entre HR e ERP: DeltaIntegrationFlow;

• sincronização massiva de catálogo: BatchDeltaIntegrationFlow.

Para uma tabela de decisão mais direta, consulte Como escolher um flow.