API HTTP
La API cubre las credenciales del tenant, el margen y los datos del trabajador, las subastas y las ofertas, los documentos, y el desembolso. Cubre la averbação y su documentación, la importación de contratos, y los códigos de instrumento B3. También cubre las correcciones de contrato, el ciclo de vida del contrato, la portabilidad en ambas direcciones, el refinanciamiento, la renegociación, y las garantías. Las operaciones restantes cubren la conciliación, el saldo devedor, los fondos, los originadores, las cesiones, el throughput, y las suscripciones de entrega. Un fondo o un originador también puede llamar a sus propias rutas, bajo/v1/consignado/fundos/{fundo_id}/ y /v1/consignado/originadores/{originador_id}/, con una credencial de socio de Access Manager. Consulta Configurar un tenant.
Empieza con obtener el margen del trabajador, y luego usa la navegación de la Referencia de la API para encontrar las demás familias de operaciones.
Comandos de Lender consumidos
El gateway lee un único flujo de comandos de aplicación y despacha según el source y la clave de evento de CloudEvent. La selección se hace por clave, nunca por nombre de tema. El gateway pone en cuarentena una clave que no maneja en su propia dead-letter queue, en lugar de omitirla.
La averbação y su documentación no son comandos de Lender. Envía ambas a través de las operaciones HTTP autenticadas.
Hechos de Lender consumidos
El mismo consumidor también lee el tema de hechos de Lender. Actúa sobre cuatro claves de hecho y omite todos los demás hechos de Lender.Hechos de negocio declarados y operacionales
STREAMING_EVENT_POLICIES puede desactivar cualquier hecho de Consignado. La escritura de negocio igual hace commit, y el gateway no publica ese hecho después.
El descubrimiento de portabilidad entrante está desactivado por defecto. El hecho consignado.portability_proposal.received aparece solo donde ese flujo está habilitado. Hace commit de forma atómica junto con su marcador duradero cuando el poller programado de descubrimiento de portabilidad encuentra una oferta activa. Lo mismo aplica para cualquier comando del riel que un despliegue no ejecute. Los hechos operacionales cubren:
- solicitudes de subasta y propuestas de portabilidad entrante
- margen, empleo, e informes de ausencia
- aceptación de propuesta, registro de contrato (
consignado.contract.registered, incluida la evidencia del artefacto CCB firmado), desembolso, y disponibilidad de corrección - aceptación de la averbação, además de resultados de averbação, exclusión, portabilidad del lado de origen, y renegociación
- conciliación, excepciones de repasse, y calendarios
- cesiones, códigos de instrumento B3, y cambios de throughput
- pausa y reanudación del riel para un tenant durante el cambio de competencia de Dataprev, en Lerian Cloud
Flujos de aplicación
Cada aplicación publica hechos en un tema, y Lender envía comandos en un tema propio:- los hechos van a
lerian.streaming.consignado-gw - el gateway lee los comandos de Lender desde
lerian.streaming.lender.commands - el gateway lee los hechos de Lender desde
lerian.streaming.lender - los tipos de hecho usan
studio.lerian.consignado-gw.<resource>.<event> - los tipos de comando usan
studio.lerian.lender.<resource>.<event>
Suscripciones de entrega
Usa la API de suscripciones para registrar un destino de entrega, leer el estado de su entrega, rotar su secreto de firma, probar la entrega, o revocar el destino. Solo las respuestas de creación y de rotación llevan el secreto de firma. Ninguna lectura lo devuelve. Las lecturas muestran un destino enmascarado. Solo el rol admin puede leer el destino completo, porque la ruta de un webhook puede llevar un token de callback. Crear, rotar y revocar requieren el headerX-Idempotency. Una suscripción recibe el major de schema 1 de cada tipo de evento, a menos que defina schema_major. Su mapa event_majors reemplaza el major para los tipos de evento que nombra.
Una prueba exitosa demuestra la entrega al endpoint configurado. No cambia la semántica de al menos una vez de los eventos de negocio.
Contrato de confiabilidad
- Los hechos de negocio entran en un outbox transaccional antes de la publicación.
- La entrega es al menos una vez.
- Deduplica por
(ce-source, ce-id). - Los valores monetarios viajan como cadenas decimales, nunca como punto flotante binario.
- Los campos del payload usan
snake_case, exceptoconsignado.registro_b3.registered, que usacamelCase. Las marcas de tiempo usan UTC RFC 3339. - Un identificador de negocio requerido faltante es terminal y va a la DLQ del consumidor en lugar de a Dataprev.