Afeta
Equipes que usam os guias, a referência da API ou a documentação de Console do Matcher. Esta atualização se aplica ao portal público de documentação. Ela não muda o comportamento da API em runtime, a menos que a documentação do produto vinculada diga o contrário.
O que mudou
A documentação do Matcher foi auditada por inteiro e alinhada com a branch
main atual. Este release inclui 27 páginas de guia, 119 páginas de referência da API, 19 páginas de console e uma especificação OpenAPI 3.1 verificada.
O que mudou
Guias
Visão geral
- O que é o Matcher: Visão geral do produto, arquitetura e onde o Matcher se encaixa na plataforma Lerian
- Conceitos do Matcher: Conceitos centrais (contextos, fontes, regras, mapeamento de campos, execuções de correspondência, exceções e disputas)
- Arquitetura do Matcher: Arquitetura do sistema, módulos de domínio e fluxo de dados
Primeiros passos
- Pré-requisitos: Requisitos e dependências
- Instalando o Matcher: Configuração e deploy
- Primeiros passos com o Matcher: Passo a passo de ponta a ponta, da criação do contexto até a primeira conciliação
Configuração
- Contextos e fontes: Definir o escopo da conciliação e conectar sistemas
- Regras de correspondência: Tipos de regra (exata, tolerância, defasagem de data), ordem de prioridade e reordenação
- Mapeamento de campos: Mapear os campos da fonte para o modelo canônico do Matcher
- Regras de tarifas: Validação de tarifas e configuração de tolerância
- Roteamento de exceções: Encaminhar transações não conciliadas para revisão
- Modo multi-tenant: Isolamento e configuração de tenant
- Configuração de runtime (Systemplane): Parâmetros de runtime e configurações no nível do sistema
Conciliação diária
- Enviando arquivos: Importar dados de transações pela API
- Revisando correspondências: Inspecionar resultados e grupos de correspondência
- Resolvendo exceções: Workflows e resolução de exceções
- Gerando relatórios: Dashboard, relatórios de conciliados/não conciliados/variação e exportações
Integrações
- Integração com o Midaz: Usar o Matcher com os dados do ledger do Midaz
- Fontes externas: Conectar extratos bancários e sistemas de terceiros
- Discovery: Descoberta automática de conexões de dados externas
- Webhooks e callbacks: Notificações orientadas a eventos
Referência
- Pontuação de confiança: Como o Matcher calcula a confiança da correspondência
- Multimoeda: Conciliação entre moedas
- Divisão e agregação: Padrões de correspondência 1:N e N:M
- Segurança: Autenticação, autorização e proteção de dados
Casos de uso
- Conciliação de Pix: Guia passo a passo para conciliar transações Pix
Lerian Console
- Usando o Matcher no Lerian Console: Visão geral da integração com o console
- 19 páginas de console cobrindo todo o módulo Matcher:
- Contextos: Gerenciar contextos, fontes, regras e agendamentos
- Conciliação: Enviar dados, disparar execuções, revisar correspondências
- Exceções e disputas: Gerenciar exceções, detalhes de exceção e disputas
- Governança: Mapeamentos de atores, logs de auditoria, arquivamentos
- Operações: Dashboard, agendamentos de tarifas, correspondência manual, histórico operacional
Referência da API
- Início rápido para desenvolvedores: Passo a passo da API, da configuração do contexto até a conciliação
- Lista de erros: Referência completa de códigos de erro
- 119 páginas de referência de endpoint cobrindo toda a superfície da API:
- Configuração: Contextos, fontes, regras, mapas de campos, agendamentos, regras de tarifas, agendamentos de tarifas
- Ingestão: Jobs de importação, busca de transações
- Correspondência: Execuções, grupos de correspondência
- Exceções: Gestão de exceções, comentários, histórico
- Disputas: Ciclo de vida da disputa
- Relatórios: Métricas do dashboard (taxa de correspondência, volume, SLA, impacto de caixa, detalhamento por fonte), relatórios de conciliados/não conciliados/variação com exportação
- Discovery: Conexões, introspecção de schema, ponte de extração
- Governança: Logs de auditoria, mapeamentos de atores, arquivamentos
- Exportação: Jobs de exportação com download
Especificação OpenAPI
- Especificação OpenAPI 3.1 do Matcher: Especificação legível por máquina com todos os 117 endpoints, schemas e exemplos, verificada contra o código-fonte
Principais correções deste release
- Caminhos de API corrigidos: Prefixos de rota alinhados ao registro real de rotas do Fiber
- Campos deprecados removidos:
rateIdremovido de todos os schemas (rejeitado pela API desde a depreciação) - Schemas ausentes adicionados: Arrays inline
sourceserulesadicionados aoCreateReconciliationContextInput - Especificação da API reforçada: Valores de enum com dois-pontos (
1:1,1:N,N:M) devidamente entre aspas, para evitar interpretação errada do parser - Exemplos dos guias corrigidos: URLs de endpoint incorretas nos exemplos com curl corrigidas em todos os idiomas
Impacto
Esta é uma atualização de documentação. As integrações existentes não precisam de migração apenas por esta nota de release.
O que você precisa fazer
1
Revise a documentação atualizada do Matcher antes de planejar novos trabalhos de implementação do Matcher.