Openi DeveloperDeveloper
Guia de integração

Visão geral

O que é o Nexus e o fluxo recomendado de integração.

Este guia descreve, em ordem prática, como uma aplicação cliente integra com o Nexus para:

  1. autenticar requisições;
  2. ingerir dados (criar data source → configurar dataset + fields → carregar dados por webhook, arquivo, Postgres, OpenFinance ou Openi → criar rule set);
  3. executar matching e consultar resultados;
  4. receber eventos por webhook de saída.

Glossário rápido

TermoO que é
Data sourceOrigem de dados configurada no Nexus. Pode ser webhook, postgres, file, openfinance ou openi.
SlugIdentificador público da URL de ingestão (/hooks/{slug}).
DatasetColeção de registros (records) extraídos de um data source. É a unidade usada pelos rule sets.
FieldChave canônica extraída do payload (ex.: amount, doc). É o que as regras referenciam.
RecordUm registro individual dentro de um dataset (uma transação, uma nota fiscal, etc.).
Rule setRegra de matching que casa records de dois datasets (left × right) por meio de uma expressão JSONata + parâmetros de pontuação.
MatchResultado da comparação de um par (record left, record right) sob um rule set. Possui score e decision.

Convenções

  • <API_BASE> é a URL base do Nexus (ex.: https://nexus-api.openi.com.br).
  • Todos os corpos de requisição/resposta são application/json salvo indicação em contrário.
  • Uploads de arquivos usam multipart/form-data.
  • Erros seguem o envelope { "error": { "code": "<CODE>", "message": "<descrição>" } } com o status HTTP apropriado. Exceção: 409 WINDOW_EXPIRED em /hooks/{slug} retorna { "ok": false, "code": "WINDOW_EXPIRED" } (sem o campo error).
  • Datas são ISO 8601 em UTC.
  • UUIDs são v4.

On this page