Openi DeveloperDeveloper
Guia de integração

Gatilhos

Conciliação automática sempre que uma ingestão adiciona registros a um dos datasets.

Um gatilho liga um ruleset a um par de datasets e cria um job sozinho sempre que uma ingestão concluída adiciona registros novos a qualquer um dos dois. Com ele, a integração só envia os registros e recebe os matches por webhook, sem chamar POST /v1/jobs.

Criar

Escopo admin. O ruleset é validado contra os dois datasets na criação, como num job.

curl -s -X POST https://nexus-v2.openi.com.br/v1/triggers \
  -H "Authorization: Bearer $NEXUS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "ruleset_id": "<ruleset_id>",
    "left_dataset_id": "<notas_id>",
    "right_dataset_id": "<pagamentos_id>",
    "lookback_days": 60,
    "debounce_seconds": 120
  }'
AtributoUso
ruleset_id, left_dataset_id, right_dataset_idRuleset e par de datasets
ruleset_versionOpcional. Fixa uma versão; sem ele, cada job usa a versão mais recente no momento em que é criado
lookback_daysSó registros ingeridos nos últimos N dias participam (1 a 3660). Padrão 90
debounce_secondsOpcional. Espera este tempo sem novas ingestões antes de começar o job (1 a 3600)
max_wait_secondsCom debounce_seconds: espera máxima desde a primeira ingestão, mesmo que continuem chegando (1 a 86400, e pelo menos debounce_seconds). Padrão 1800, ou debounce_seconds se for maior

Quando o job começa

  • Sem debounce_seconds: o job entra na fila logo após a ingestão.
  • Com debounce_seconds: cada nova ingestão adia o início, até o limite de max_wait_seconds contado da primeira. Uma rajada de cargas (um arquivo por filial, por exemplo) vira um job só, que começa quando a rajada termina.

Enquanto o job do gatilho ainda não começou, novas ingestões atualizam esse mesmo job em vez de criar outro. Ingestões que não carregam registros novos (só duplicados, ou que falharam) não disparam nada.

Os jobs criados por gatilho têm trigger_id e aparecem em GET /v1/jobs?origin=trigger. Como todo job, eles só carregam os registros ainda abertos no ruleset, então cada execução concilia o que chegou e o que ficou pendente das anteriores, dentro do lookback_days.

Alterar e remover

PATCH /v1/triggers/{id} liga e desliga (enabled) e muda lookback_days, debounce_seconds e max_wait_seconds. debounce_seconds: null volta a começar os jobs imediatamente. O ruleset e os datasets não mudam: para trocar, crie outro gatilho e apague o antigo com DELETE /v1/triggers/{id}.

On this page