Conceptos Core de la API Universal
Bienvenido a la documentación de la API Universal de Blacktrust. Para interactuar correctamente con nuestra API, es fundamental comprender la jerarquía de entidades y cómo se estructura la información devuelta por el sistema.
Jerarquía del Sistema
Nuestra arquitectura se basa en tres componentes principales interconectados:
1. Client (Cliente)
El Client representa la entidad empresarial que consume la API. Cada cliente posee credenciales de acceso que validan su identidad y restringen el acceso solo a los datos y configuraciones que le pertenecen.
2. Package (Paquete)
Un Package funciona como un agrupador estratégico. Actúa como un contenedor de reglas de negocio, validaciones personalizadas y un conjunto de procesos específicos (por ejemplo: "Paquete Operativo VIP"). Un mismo cliente puede tener múltiples paquetes configurados según sus necesidades. La seguridad valida que un packageId pertenezca al clientId autenticado.
3. Process (Proceso)
Los Processes son las validaciones individuales y modulares que componen un paquete (Ejemplo: Identity Validation, BGC Legal, Credit Report).
Nota: En toda nuestra documentación y arquitectura, nos referimos a estos servicios atómicos exclusivamente como Processes.
Interpretación de Resultados
La API Universal expone distintos grados de detalle para optimizar el rendimiento y adaptarse a tus flujos asíncronos. La estructura de respuesta evoluciona desde un estado superficial hasta datos técnicos complejos.
Resumen de la Solicitud (Request Overview)
Es la respuesta por defecto al consultar el estado de un uuid. Representa el estado global del paquete y desglosa la lista de Processes individuales incluidos con sus respectivos estados de avance.
- Uso: Determinar si un request entero está
Pending,In ProcessoCompleted, y verificar el avance granular de cada proceso.
Resumen del Proceso (Process Summary)
Proporciona la interpretación amigable y ejecutiva de un proceso una vez completado.
- Uso: Tomar decisiones directas de negocio (ej. "Sin antecedentes penales", "BC Score: 720").
Datos Técnicos Extendidos (Extended Technical Data)
Se obtiene exclusivamente usando el parámetro ?detail=true. Retorna el 100% de la carga útil original proporcionada por el motor de scraping o servicio integrado, incluyendo todos los registros paginados.
- Uso: Mostrar una interfaz visual hiper-detallada o realizar auditorías de seguridad profunda.
Ten en cuenta que al consultar el Resumen del Proceso o los Datos Técnicos Extendidos, algunos procesos (como BGC Legal) pueden devolver listados extensos. Debes preparar tu UI para procesar información paginada de manera alfabética.