El backend de DQE One para Salesforce expone API utilizadas por el paquete de Salesforce para activar y gestionar procesos backend: configurar fuentes de datos, ejecutar trabajos de fusión y auditoría, y gestionar las sesiones de la interfaz personalizada integrada del paquete.
La API DQE One es diferente de las demás API de DQE documentadas en este Centro de ayuda: no es un servicio público de búsqueda o validación que llamen directamente tus propias aplicaciones. Es el backend utilizado internamente por el paquete DQE One para Salesforce — el paquete la llama (y un subconjunto de endpoints son, a su vez, llamados por servicios alojados en DQE que actúan en nombre del paquete) para obtener la configuración de limpieza de datos, lanzar trabajos backend y gestionar la interfaz personalizada del paquete. Este artículo presenta la API en su conjunto; cada uno de los demás artículos de esta familia documenta en detalle un área funcional.
Modelo de autenticación
La API DQE One define dos esquemas de seguridad distintos en su especificación OpenAPI. La mayoría de los endpoints requieren uno de los dos; algunos pocos — como la comprobación de disponibilidad de más abajo — no requieren ninguno.
| Esquema | Cómo funciona | Uso habitual |
|---|---|---|
| DQE-Authorization | Una clave de API enviada en una cabecera HTTP personalizada llamada DQE-Authorization.
OpenAPI type: apiKey, in: header
|
La mayoría de los endpoints backend llamados por el paquete de Salesforce — por ejemplo, emitir un token de proceso o gestionar la configuración de datos. |
| bearerAuth | Un JSON Web Token Bearer estándar enviado en la cabecera Authorization, por ejemplo Authorization: Bearer {JWT}.
OpenAPI type: http, scheme: bearer, bearerFormat: JWT
|
Un conjunto más reducido de endpoints de gestión de la interfaz personalizada. |
DQE-Authorization o un JWT Bearer fuera de los flujos de token/suscripción descritos en el artículo Autenticación y sesión aún no ha sido documentada por el equipo de ingeniería de DQE — confirma con el equipo antes de publicar si algo aquí necesita corrección.Cada endpoint declara su propio requisito individualmente. Consulta el artículo Autenticación y sesión para ver los tres endpoints que emiten o consumen estas credenciales, y cada artículo específico de endpoint para saber qué espera ese endpoint en particular.
Artículos de esta familia
La API DQE One está documentada en cinco artículos:
| Artículo | Cubre |
|---|---|
| Introducción | Esta página — resumen, modelo de autenticación y la comprobación de disponibilidad GET /echo. |
| Autenticación y sesión |
POST /getOAuthTokenForProcess, POST /subscribe, POST /customUI/createTokenSession. |
| Configuración de datos |
POST /getDCMetadata, POST /getFusionField, POST /createFusionLookup. |
| Trabajos y auditorías |
POST /newJob, POST /launchAudit, POST /previewDataPrep. |
| Gestión de la interfaz personalizada |
POST /customUI/resetRules, POST /customUI/importRules. |
/lanchAudit (sic — parece ser un duplicado o una errata de /launchAudit; no tiene operationId y no declara ningún esquema de seguridad) y un cuerpo de solicitud de /newJob definido como un $ref que apunta al propio cuerpo de solicitud de /lanchAudit en lugar de a un esquema de componente compartido. Ninguna de estas dos anomalías se resuelve en esta introducción — señala ambas al equipo de ingeniería de DQE antes de documentar /newJob y /launchAudit.Comprobación de disponibilidad — GET /echo
Solicitud
Una simple comprobación de disponibilidad para confirmar que el backend es accesible. No recibe parámetros ni requiere autenticación.
{DOMAIN} es el dominio del backend configurado para tu instancia del paquete DQE One. La especificación OpenAPI lo modela como una variable de servidor domain configurable, en lugar de un único host fijo.
Respuesta
Devuelve un objeto JSON fijo que confirma que el servicio está activo.
| Clave | Descripción | Tipo |
|---|---|---|
| status | Valor fijo que confirma que el backend es accesible. | String |
Ejemplo de respuesta
Errores
La especificación de origen no define ninguna respuesta de error para este endpoint.
Probar la API
Haz clic en el botón de abajo para probar este endpoint en vivo desde tu navegador.
Abrir consola
Ver también
Relacionada con