Skip to main content
Use a API HTTP para toda a superfície de Consignado voltada ao cliente. Use CloudEvents para consumir fatos de negócio imutáveis e, quando integrar pelo Lender, para enviar os comandos compatíveis. As duas interfaces são complementares; o fluxo de eventos não é a autoridade para todas as operações do trilho.

​
API HTTP

A API abrange credenciais de tenant, margem e dados do trabalhador, leilões e lances, registro, documentos, desembolso, ciclo de vida do contrato, portabilidade, refinanciamento, renegociação, garantias, conciliação, fundos, cessões, uso, throughput e assinaturas de entrega. Comece por consultar a margem do trabalhador e, depois, use a navegação da referência da API para encontrar as demais famílias de operações. Cada página de operação é gerada a partir do contrato OpenAPI de develop.

​
Comandos Lender consumidos

O gateway lê um fluxo de comandos de aplicação e faz o dispatch pela fonte de CloudEvent e pela chave de evento. A averbação não é um comando Lender em develop. Envie-a pela operação HTTP autenticada.

​
Fatos de negócio declarados e operacionais

O manifesto de runtime declara 21 fatos de negócio, e todos os 21 têm pontos de emissão em produção em develop. consignado.portability_proposal.received é emitido quando o processo agendado de descoberta de portabilidade encontra uma oferta M011 válida e confirma atomicamente seu marcador durável com o envelope do outbox de streaming. Os fatos operacionais abrangem:
  • solicitações de leilão e propostas de portabilidade recebidas
  • relatórios de margem, emprego e afastamento
  • aceitação de propostas, registro de contratos (consignado.contract.registered, incluindo a evidência do artefato de CCB assinado) e desembolso
  • resultados de averbação, exclusão e redirecionamento
  • conciliação, exceções de repasse e calendários
  • alterações de fundos, cessões e throughput
Veja eventos de Consignado para o catálogo completo e o mapeamento exato de recurso/evento do CloudEvent.

​
Fluxos de aplicação

Com o contrato lib-streaming v3:
  • os fatos são produzidos em lerian.streaming.consignado-gw
  • os comandos Lender são consumidos de lerian.streaming.lender.commands
  • os tipos de fato usam studio.lerian.consignado-gw.<resource>.<event>
  • os tipos de comando usam studio.lerian.lender.<resource>.<event>
Roteie pela fonte do CloudEvent, tipo de recurso e tipo de evento. Não infira um evento apenas pelo nome de um tópico.

​
Assinaturas de entrega

Use a API de assinaturas para registrar um destino HTTPS, inspecioná-lo, rotacionar seu segredo de assinatura, testar a entrega ou revogá-lo. Trate o segredo de assinatura como somente escrita. Um teste bem-sucedido comprova a entrega ao endpoint configurado; ele não altera a semântica de pelo menos uma vez dos fatos de negócio.

​
Contrato de confiabilidade

  • Fatos de negócio entram em um outbox transacional antes da publicação.
  • A entrega é pelo menos uma vez.
  • Desduplique por (ce-source, ce-id).
  • Valores monetários trafegam como strings decimais, nunca como ponto flutuante binário.
  • Campos de payload usam snake_case; timestamps usam UTC RFC 3339.
  • A ausência de um identificador de negócio obrigatório é terminal e vai para a DLQ do consumidor, em vez da Dataprev.