Skip to main content
Lerian Consignado combina comandos HTTP síncronos con hechos asíncronos y lecturas programadas de Dataprev. La API HTTP admite trabajo y responde consultas. El outbox publica hechos de negocio. Los workers en segundo plano descubren o recuperan el estado que Dataprev expone como feeds en lugar de callbacks.

​
1. Configura un tenant

Antes de que un tenant pueda llamar al riel, registra:
  • un certificado de cliente ICP-Brasil A1 y una clave privada
  • credenciales de cliente OAuth2
  • el código solicitante de Dataprev de tres dígitos del tenant
  • la URL base del portal del trabajador utilizada en las propuestas de oferta
El estado de las credenciales devuelve presencia, huella digital del certificado y metadatos de vencimiento. Nunca devuelve el certificado, la clave privada ni el secreto de OAuth.

​
2. Consulta los datos y el margen del trabajador

El endpoint de margen autentica al tenant, obtiene el contexto de autorización de Dataprev del trabajador y devuelve la respuesta del riel sin convertirla en una decisión de evaluación de riesgo. La API también expone nuevos vínculos laborales, informes de terminación, registros de FGTS autorizados y lecturas de saldo de FGTS.

​
3. Descubre subastas y envía propuestas

Un ciclo de descubrimiento programado enumera las solicitudes de préstamo abiertas. Después, puedes enviar una oferta mediante la API HTTP autenticada. El gateway conserva la carga útil durable de la oferta necesaria para demostrar lo que enviaste y luego publica el testigo de propuesta aceptada. Las subastas de portabilidad usan una operación de respuesta separada y una ventana de solicitud de Dataprev limitada.

​
4. Registra y desembolsa el contrato

El flujo de registro:
  1. registra el contrato en Dataprev
  2. adjunta el documento CCB cuando sea necesario
  3. expone el estado del registro y los documentos del riel
  4. registra la confirmación de desembolso del cliente
  5. publica hechos inmutables de registro y pago a través del outbox
Un prestamista o ledger posterior decide qué significan esos hechos para sus propios libros. El gateway no registra directamente en el ledger.

​
5. Gestiona el contrato

La API cubre el ciclo de vida del riel después del registro: suspensión, reactivación, cambios de plazo, anticipación y reversión de cuotas, exclusión, refinanciación y reversión, renegociación, registro de portabilidad y operaciones de contratos heredados. La exclusión es una operación recuperable. El comando autenticado inicial registra la intención y un ciclo de recuperación programado lleva el trabajo admitido a un estado terminal en el riel. Repetir el mismo comando idempotente no crea una segunda exclusión.

​
6. Concilia la nómina y los repasses

El worker de conciliación lee dos fuentes independientes de Dataprev:
  • registros contables, identificados por la competencia de nómina y el contexto del contrato
  • registros de repasse de la CEF, que representan el movimiento de liquidación
El gateway emite un hecho de conciliación por cada registro de fuente y rastrea los repasses esperados. Un repasse puede atrasarse, resolverse posteriormente o dejar de ser observable cuando el gateway no puede establecer una vista actual del riel. Los consumidores no deben tratar el silencio como liquidación.

​
7. Opera carteras y garantías

Las familias de API adicionales cubren calendarios operativos, terminaciones laborales, ejecución de garantías de FGTS, fondos, créditos cedidos, cesiones, throughput por tenant, uso y suscripciones de entrega de eventos.
La referencia de la API se genera a partir del contrato de develop del producto. Usa la página de la operación para consultar los encabezados obligatorios exactos, las reglas de idempotencia, los rangos de validación y los esquemas de respuesta.