Ejecutar Enriquecimiento por ID Externo
Referencia API
Ejecutar Enriquecimiento por ID Externo
Ejecuta integraciones de enriquecimiento del marketplace en una entidad usando su identificador externo. Consulta el esquema del request, códigos de respuesta.
POST
Ejecutar Enriquecimiento por ID Externo
Descripción General
Ejecuta una o más integraciones de enriquecimiento del marketplace en una entidad específica usando su identificador externo. Este endpoint primero busca la entidad por su externalId, luego ejecuta los enriquecimientos. Es idéntico al endpoint por ID pero más conveniente cuando usa sus propios identificadores de entidad. Nota:enrichmentGroupRefs aplica solo a esta API de ejecución del marketplace (y a POST .../marketplace/enrichment por UUID de entidad). La creación de entidades (manual o automática) sigue usando solo códigos explícitos, no slugs de grupo.
Endpoint
Autenticación
Requiere una clave API válida en el encabezado de autorización:Cuerpo de la Solicitud
Su identificador externo para la entidad (por ejemplo, su ID de cliente, ID de usuario, etc.)
Lista explícita de códigos de integración de enriquecimiento a ejecutar. Ver Códigos de Proveedores de Integración.Podés enviar solo
integrationCodes, solo enrichmentGroupRefs o ambos. Si enviás ambos, la API expande los grupos a códigos, concatena integrationCodes y deduplica manteniendo el orden de primera aparición. Al menos uno de integrationCodes o enrichmentGroupRefs debe ser no vacío.Referencias a grupos de enriquecimiento configurados para tu organización en el Marketplace. Cada valor es el slug del grupo o el UUID del grupo. El servidor reemplaza cada referencia por los códigos guardados en ese grupo (en orden) y luego fusiona los
integrationCodes. Cada código sigue sujeto a las mismas reglas del orquestador que una solicitud directa (tipo de catálogo, habilitación en la org, bloqueos, etc.).Parámetros adicionales opcionales para pasar a las integraciones
Respuesta
Si la operación de enriquecimiento en lote se completó exitosamente
El UUID interno resuelto de la entidad enriquecida
El ID externo que se usó para buscar la entidad
Array de resultados de enriquecimiento, uno por cada código de integraciónCada resultado contiene:
success(boolean) - Si este enriquecimiento específico tuvo éxitoenrichmentId(string) - UUID del registro de ejecución del enriquecimientointegrationCode(string) - El código de integración que fue ejecutadointegrationName(string) - Nombre legible de la integraciónresult(object) - Datos de enriquecimiento (solo si fue exitoso)fieldsEnriched(array) - Lista de campos de entidad que fueron enriquecidosdataQuality(object) - Métricas de calidadcompleteness(number) - Puntuación de completitud de datos (0-1)confidence(number) - Puntuación de confianza (0-1)
summary(string) - Resumen legibleenrichmentData(object) - Los datos de enriquecimiento reales
executionTime(number) - Tiempo de ejecución en milisegundoscostCents(number) - Costo de este enriquecimiento en centavoserror(object) - Detalles del error (solo si falló)code(string) - Código de errormessage(string) - Mensaje de error
Costo total de todos los enriquecimientos en centavos
Tiempo total de ejecución para todos los enriquecimientos en milisegundos
Ejemplos
Ejecutar un Solo Enriquecimiento
Ejecutar Múltiples Enriquecimientos (Lote)
Ejemplo de Respuesta - Enriquecimiento Exitoso
Ejemplo de Respuesta - Lote con Resultados Mixtos
Respuestas de Error
404 Entidad No Encontrada
401 No Autorizado
400 Solicitud Incorrecta
Casos de Uso
Enriquecimiento de Datos KYC
Enriquecer una entidad de persona con datos oficiales del gobierno:Debida Diligencia de Empresa
Recopilar datos completos de empresa desde múltiples fuentes:Notas Importantes
- Ejecución en Lote: Múltiples enriquecimientos se ejecutan en paralelo para mejor rendimiento
- Seguimiento de Costos: El costo de cada enriquecimiento se rastrea individualmente y se suma en
totalCostCents - Éxito Parcial: El lote puede tener éxito incluso si algunos enriquecimientos individuales fallan
- Auditoría Automática: Todos los enriquecimientos se registran automáticamente en el registro de auditoría
- Activación de Reglas: Los enriquecimientos exitosos activan el motor de reglas con el evento
enrichment_completed - Idempotencia: Ejecutar el mismo enriquecimiento múltiples veces puede devolver resultados en caché a menos que se use
forceRefresh
Endpoints Relacionados
- Ejecutar Enriquecimiento por ID Externo - Usa tu propio identificador de entidad
- Obtener Entidad - Ver datos de entidad enriquecida
- Listar Proveedores de Integración - Códigos de enriquecimiento disponibles