Openi DeveloperDeveloper

Nexus

Motor de conciliação: datasets tipados, regras versionadas, jobs de matching e webhooks.

O Nexus concilia registros de duas bases: notas fiscais contra pagamentos, vendas contra recebíveis, guias contra extratos. Você envia os registros para datasets tipados, descreve num ruleset como os dois lados se relacionam e roda jobs que gravam os matches. O resultado sai por consulta na API e por webhook.

  • Base URL: https://nexus-v2.openi.com.br
  • Autenticação: chave de API do tenant, enviada como Authorization: Bearer nxk_...
  • Formato: JSON; erros no padrão application/problem+json
  • Contrato: OpenAPI em /openapi.json

Por onde começar

  1. Visão geral: conceitos e o fluxo completo, do dataset ao match, com exemplos.
  2. Autenticação: formato da chave, escopos e como conferir a chave em uso.
  3. Padrões da API e Erros: identificadores, paginação, datas, valores e respostas de erro.
  4. Datasets e Ingestão: schema tipado, normalização e carga inline ou por arquivo.
  5. Rulesets e matching e Composição: regras em CEL, blocking, pontuação e conciliação 1:N, N:1 e N:M.
  6. Jobs e revisão: execução, acompanhamento, revisão de possible e match manual.
  7. Gatilhos e Workflows: conciliação automática após cada ingestão e etapas encadeadas.
  8. Webhooks: eventos, assinatura, retentativas e reenvio.
  9. Referência da API: todos os endpoints, gerados do contrato OpenAPI.

Nexus anterior descontinuado

Esta documentação cobre o Nexus atual. O Nexus anterior, com data sources, ingestão por /hooks/{slug}, imports de arquivo, regras em JSONata e autenticação por x-api-key, foi descontinuado. Nenhum desses endpoints existe na API atual.

On this page