1. Configurar un tenant
Antes de que un tenant pueda llamar al riel, registra:- un certificado de cliente ICP-Brasil A1 y su clave privada
- credenciales de cliente OAuth2
- el código de solicitante de Dataprev de tres dígitos del tenant
- opcionalmente, la URL base del portal del trabajador ofrecida como contacto de formalización en las propuestas de oferta
2. Leer los datos y el margen del trabajador
El endpoint de margen autentica al tenant, obtiene el contexto de autorización del trabajador en Dataprev, y devuelve la respuesta del riel sin convertirla en una decisión de suscripción. La API también expone nuevos vínculos de empleo, informes de terminación, registros de FGTS autorizados, y lecturas de saldo de FGTS.3. Descubrir subastas y enviar propuestas
Un bucle programado de descubrimiento lista las solicitudes de préstamo abiertas. Un cliente puede entonces enviar una oferta a través de la API HTTP autenticada. El gateway conserva el payload duradero de la oferta necesario para demostrar lo que el cliente envió y luego publica el testigo de la propuesta aceptada. Toda propuesta debe llegar al trabajador a través de al menos un contacto. El gateway agrega el portal de formalización del tenant como contacto cuando el tenant registra uno. Una oferta puede anular ese portal para su propio envío. El gateway rechaza una propuesta sin portal registrado y sin contacto del cliente antes de llamar a Dataprev. Las subastas de portabilidad usan una operación de respuesta separada y una ventana acotada de solicitud a Dataprev.4. Registrar y financiar el contrato
El flujo de registro:- registra el contrato con Dataprev
- adjunta el documento CCB cuando se requiere
- expone el estado de registro y los documentos del riel
- registra la confirmación de desembolso del cliente
- publica hechos inmutables de contabilización y pago a través del outbox
5. Dar servicio al 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, y exclusión. También cubre refinanciamiento y reversión, renegociación, registro de portabilidad, y operaciones de contratos heredados. La portabilidad funciona en ambas direcciones. Como institución proponente, registra la portabilidad entrante. Como institución de origen, excluye el contrato del que se alejó el trabajador. El gateway acepta eso solo para un contrato que él mismo registró. Rechaza cualquier otra cosa antes de llamar al riel. Revertir un refinanciamiento funciona de la misma manera. Solo puedes revertir un refinanciamiento a través de este gateway si el gateway lo registró. La ventana de 7 días hábiles se evalúa contra el propio registro del gateway de cuándo ese refinanciamiento hizo commit. La exclusión es una operación recuperable. El comando autenticado inicial registra la intención, y un bucle programado de recuperación lleva el trabajo admitido a un estado terminal del riel. Repetir el mismo comando idempotente no crea una segunda exclusión. El refinanciamiento, la reversión, la renegociación, y la exclusión de portabilidad del lado de origen tienen su propio bucle de recuperación por la misma razón. El bucle converge un comando cuyo resultado nadie estableció contra el registro del riel, en lugar de perderlo.6. Conciliar la nómina y el repasse
El worker de conciliación lee dos fuentes independientes de Dataprev:- registros de contabilidad, indexados por la competencia de nómina y el contexto del contrato
- registros de repasse de la CEF, que representan el movimiento de liquidación
7. Operar carteras y garantías
Familias adicionales de la API cubren calendarios operativos, terminaciones de empleo, ejecución de garantía de FGTS, fondos, créditos cedidos, cesiones, throughput por tenant, uso, y suscripciones de entrega de eventos.La referencia de la API proviene del contrato
develop del producto. Usa la página de la operación para conocer los headers exactos requeridos, las reglas de idempotencia, los rangos de validación, y los esquemas de respuesta.
