> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Integre-se ao Lerian Consignado — Dataprev

> Integre-se pela API HTTP autenticada, pelo stream de comandos do Lender, pelos fatos de negócio do Consignado e pelas subscriptions de entrega de eventos.

Use a API HTTP para a superfície completa do Consignado voltada ao cliente. Use CloudEvents para consumir fatos de negócio imutáveis e, ao integrar-se pelo Lender, para enviar os comandos suportados. As duas interfaces são complementares. O stream de eventos não é a autoridade para toda operação do trilho.

## API HTTP

A API cobre credenciais de tenant, dados de margem e de trabalhador, leilões e lances, registro, documentos e desembolso. Ela também cobre correções de contrato, ciclo de vida do contrato, portabilidade nos dois sentidos, refinanciamento, renegociação e garantias. As demais operações cobrem conciliação, fundos, cessões, uso, vazão e subscriptions de entrega.

Comece por [buscar a margem do trabalhador](/pt/reference/rails/consignado/fetch-consignado-worker-margin), depois use a navegação da Referência da API para encontrar as demais famílias de operação. Cada página de operação vem do contrato OpenAPI `develop`.

## Comandos do Lender consumidos

O gateway lê um único stream de comandos de aplicação e distribui as mensagens pela origem do CloudEvent e pela chave de evento. A seleção ocorre pela chave, nunca pelo nome do tópico. Uma chave que o gateway não trata vai para sua própria dead-letter queue, em vez de ser ignorada.

| Chave do evento                         | Comportamento em runtime                                                                                                                                     |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `consignado_margin.requested`           | Executa a leitura de margem do trabalhador no trilho. O próprio consumidor roda apenas quando o trilho Dataprev e o streaming estão habilitados.             |
| `consignado_exclusao.requested`         | Usa o mesmo serviço idempotente de exclusão da operação HTTP quando o runtime está disponível; caso contrário, retorna um erro nomeado de indisponibilidade. |
| `consignado_redirecionamento.requested` | Executa quando um adapter de redirecionamento está conectado; caso contrário, retorna uma recusa nomeada que pode ser reexecutada após a configuração.       |

Averbação não é um comando do Lender no `develop`. Envie-a pela operação HTTP autenticada.

## Fatos de negócio declarados e operacionais

O contrato de runtime contém 25 definições de fato de negócio, e cada uma tem um ponto de emissão de produção nomeado no `develop`. Não há toggle por fato. O conjunto de fatos publicado é uma projeção do catálogo de runtime. Um deployment emite um fato ou não executa o fluxo que o produz.

A configuração decide o que um deployment emite, nunca o fato. A descoberta de portabilidade de entrada vem desabilitada por padrão. O fato `consignado.portability_proposal.received` aparece apenas onde esse fluxo está habilitado. Ele é registrado de forma atômica com seu marcador durável quando o poller agendado de descoberta de portabilidade encontra uma oferta ativa. O mesmo vale para qualquer comando de trilho que um deployment não executa. Os fatos operacionais cobrem:

* solicitações de leilão e propostas de portabilidade de entrada
* relatórios de margem, de vínculo empregatício e de afastamento
* aceitação de proposta, registro de contrato (`consignado.contract.registered`, incluindo evidência de artefato CCB assinado), desembolso e disponibilidade de correção
* averbação, exclusão, redirecionamento e desfechos de portabilidade do lado de origem
* conciliação, exceções de repasse e calendários
* fundos, cessão e mudanças de vazão

Veja [Eventos do Consignado](/pt/reference/events/consignado) para o catálogo completo e o mapeamento exato de recurso/evento do CloudEvent.

## Streams de aplicação

Com o contrato lib-streaming v3:

* os fatos vão para `lerian.streaming.consignado-gw`
* o gateway lê os comandos do Lender em `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 origem do CloudEvent, pelo tipo de recurso e pelo tipo de evento. Não infira um evento apenas a partir do nome de um tópico.

## Subscriptions de entrega

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

## Contrato de confiabilidade

* Os fatos de negócio entram em um outbox transacional antes da publicação.
* A entrega é pelo menos uma vez.
* Deduplique por `(ce-source, ce-id)`.
* Valores monetários trafegam como strings decimais, nunca como ponto flutuante binário.
* Os campos do payload usam `snake_case`. Os timestamps usam UTC RFC 3339.
* Um identificador de negócio obrigatório ausente é terminal e vai para a DLQ do consumidor, em vez de ir para o Dataprev.