Pular para o conteúdo principal
O Pix Lerian emite fatos de negócio como CloudEvents 1.0 em modo binário de conteúdo. Quatro componentes publicam no mesmo tópico — SPI, DICT Hub, COB Hub e a API do pagador do Pix Automático — porque são módulos de uma única aplicação e compartilham uma única origem CloudEvents, plugin-br-pix-lerian. O Streaming Hub entrega esses eventos aos sistemas da sua instituição.

Como a entrega funciona


  • Pelo menos uma vez. O caso de uso grava o estado de negócio e o envelope do evento na mesma transação, em um outbox; o relay do outbox é o único publisher do broker. Um evento pode chegar mais de uma vez, mas nunca se perde depois que a mudança de estado é confirmada.
  • Dois caminhos de consumo. O Streaming Hub entrega cada evento correspondente a um sink seu — webhook HTTPS com assinatura HMAC, SQS, RabbitMQ ou EventBridge — ou seu consumidor assina o tópico lerian.streaming.plugin-br-pix-lerian com qualquer cliente Kafka.
  • Elimine duplicatas. No webhook, pelo header X-Lerian-Event-Id; no Kafka, pelo par (ce-source, ce-id).
  • Não dependa da ordem de chegada. A chave do registro é <ce-tenantid>:<subject>, o que dá afinidade de partição por tenant e agregado, não ordenação estrita. Ordene pelo ciclo de vida e pelos timestamps dentro de cada evento.
  • Despache por ce-type. O tipo é studio.lerian.plugin-br-pix-lerian.<event-key> e o valor do registro é apenas o payload (data), sem envelope. Ignore os tipos que você não trata: eventos novos aparecem sem aviso, no mesmo tópico.
  • Valores monetários vêm como string decimal; interprete-os como decimais, nunca como ponto flutuante binário. Os timestamps estão em UTC.
No caminho por webhook, verifique a assinatura HMAC sobre os bytes crus do corpo antes de qualquer parse e responda 2xx somente depois que a verificação passar e o evento estiver persistido do seu lado. O passo a passo de verificação, a rotação de segredo e os headers X-Lerian-* estão em Consumir eventos; a criação do sink está em Gerenciar subscriptions.

Descoberta de schema


Cada componente produtor serve dois endpoints HTTP sob o próprio prefixo de rota:
O manifesto lista os eventos que o componente publica e aponta para o documento JSON Schema de cada par (eventKey, schemaVersion). Use-o como contrato em tempo de deploy, em vez de adivinhar tópicos e formatos. Os dois endpoints compartilham um único grant de autorização, streaming-manifest/get, escopado ao application name do componente (plugin-br-pix-lerian-spi, -dict, -cob, -pixauto); envie o token como Authorization: Bearer <token>. Instalações com autorização desabilitada servem os dois endpoints sem autenticação.
Leia ce-schemaversion em cada registro e faça cache do documento de schema pelo par (eventKey, schemaVersion). Os produtores escrevem registros apenas na versão corrente de cada evento; uma versão substituída nunca é editada e o documento dela permanece servido para consumidores ainda fixados nela.

Todo ce-type usa studio.lerian.plugin-br-pix-lerian.<event-key>. A lista autoritativa legível por máquina é o manifesto de cada componente; as tabelas abaixo são o mesmo conjunto em prosa.

SPI

DICT Hub

COB Hub

Pix Automático