Introducción

Introducción - DQE One Standalone API

La DQE One Standalone API le permite controlar de forma remota su servidor DQE One Standalone autoalojado: cargar archivos, conectar fuentes de datos, crear y ejecutar processes de calidad de datos, seguir sus runs y gestionar RuleSets — todo lo que puede hacer en la interfaz web, para automatizar el procesamiento por lotes.

{DOMAIN} es el nombre de host de su propio servidor DQE One Standalone — es autoalojado, por lo que este valor depende de su implementación. {EMAIL} es su usuario de DQE One y {API_TOKEN} el token generado en My Account > API Token.

No se cubre aquí: la API de búsqueda de duplicados en tiempo real (Use the Lookup API in DQE One Standalone) y el servidor MCP para asistentes de IA (DQE One Standalone — MCP server).

Ir aAutenticación Convenciones Mapa de la API Ejemplo completo Limitaciones

Autenticación

Todos los endpoints utilizan autenticación HTTP Basic: su email de DQE One como nombre de usuario y su API token como contraseña (Authorization: Basic base64(email:api_token); con curl, -u "email:token"). En estas rutas no se acepta ninguna sesión, token Bearer ni OAuth.

Inicie sesión en su interfaz web de DQE One Standalone.
Abra My Account y la sección API Token, y luego genere el token.
Utilícelo como contraseña Basic. Al regenerarlo, el anterior queda invalidado.

Trate el token como una contraseña. Nunca caduca, no tiene scopes y da acceso completo a todo lo que posee su cuenta (archivos, metadatos de credentials, processes, RuleSets). Manténgalo fuera del control de código fuente y de los logs. Consulte Manage your profile in DQE One Standalone para saber cómo renovarlo.

Convenciones

Tema	Comportamiento
URL base	`https://{DOMAIN}/api/...` — DQE One Standalone es autoalojado, por lo que `{DOMAIN}` es su propio servidor.
Alcance por usuario	Todo está limitado al usuario autenticado. El id de otro usuario responde 404, nunca 403.
Éxito	`{"status":"success", ...}`. Las listas son arrays JSON simples. Los endpoints de creación responden 201, incluido `updateProcess`.
Errores	`{"status":"error","error":"<message>"}` en inglés. Las excepciones se indican en cada endpoint (por ejemplo, `runProcess` usa `message`, y la importación de RuleSets devuelve `error` como una lista).
401	`{"status":"error","error":"Unauthorized"}` para un credential ausente, incorrecto o desconocido. Una cabecera malformada (que no sea base64 o sin `:`) puede producir en su lugar un error 500 sin formato.
Métodos	Un método incorrecto responde 405. `runProcess` y `deleteProcess` son solicitudes GET que modifican datos.
Trabajo asíncrono	`runProcess` solo pone el run en cola. Consulte `getRuns` periódicamente. Los trabajos se ejecutan de uno en uno por usuario.
500 sin formato	Algunas entradas (un `id` no numérico, un process que nunca se ha ejecutado) provocan un error de servidor simple en lugar de JSON. Valide los ids por su cuenta.
Límites	Sin límite de frecuencia, sin paginación, sin límite explícito de tamaño de carga, los tokens nunca caducan. CORS está abierto a cualquier origen (la autoridad proviene de la cabecera Authorization).
Documentación interactiva	Su servidor también ofrece ReDoc en `/doc/` y Swagger UI en `/doc/swagger/`. No son del todo precisos (nombres de claves, códigos de estado, respuestas de tipo array u objeto): prefiera esta documentación y el archivo OpenAPI indicado arriba.

Mapa de la API

Artículo	Endpoints
Files	`addFile`, `listFiles`, `getProcessResult`, `deleteFile`
Credentials	`createCredential`, `listCredentials`, `getCredential`, `deleteCredential`
Processes	`createProcess`, `updateProcess`, `listProcesses`, `getProcess`, `runProcess`, `deleteProcess`
Runs & results	`getRuns`
RuleSets	`listRulesets`, `getRuleset`, `exportRulesets`, `importRuleset`
MCP server	Las mismas operaciones para asistentes de IA (Claude y otros clientes MCP): JSON-RPC en `/mcp`.

¿Busca la búsqueda de duplicados en tiempo real? Es una API independiente: Use the Lookup API in DQE One Standalone.

Ejemplo completo

Este flujo completo solo necesita un archivo CSV. Para una fuente de base de datos o CRM, cree primero un credential (Credentials) y use "source":"postgres", "object":"<table>", "credential":<id> en lugar de file.

            export DOMAIN=standalone.example.com EMAIL=you@example.com
            TOKEN=your_api_token

            # 1. Upload a file (headers: unique, no spaces)
            curl -u "$EMAIL:$TOKEN" -F "file=@contacts.csv" https://$DOMAIN/api/File/add
            # - 201 {"status":"success","id":12}

            # 2. Create a Check Email process on it
            curl -u "$EMAIL:$TOKEN" -H "Content-Type: application/json"
            \
            -d '{"name":"Email check","kind":"check_email","source":"csv","file":12,"primaryKey":"Id","fields":{"FieldLabel":"Email"}}'
            \
            https://$DOMAIN/api/Process/create
            # - 201 {"status":"success","id":42}

            # 3. Run it (asynchronous)
            curl -u "$EMAIL:$TOKEN" "https://$DOMAIN/api/Process/run?id=42"
            # - 200 {"status":"success","message":"Process Enqueue","run_id":"101"}

            # 4. Poll until status is Finished or Failed
            curl -u "$EMAIL:$TOKEN" "https://$DOMAIN/api/Run/get?id=101"

            # 5. Download the result (primary key + synchronised columns)
            curl -u "$EMAIL:$TOKEN" -OJ "https://$DOMAIN/api/File/get?processId=42"
          

El orden de limpieza importa: elimine primero el process (una vez que su run esté Finished o Failed), luego el credential y por último el archivo; cada uno se rechaza con 423 mientras algo lo siga utilizando.

Limitaciones conocidas

Los processes find_and_replace, format y audit no se pueden crear de forma fiable mediante la API, y los processes de Snowflake siempre fallan en la validación: utilice la interfaz web para ellos.
updateProcess no puede volver a establecer un booleano en false y restablece los campos que usted no envía.
No existe ningún endpoint para cancelar un run, y getProcessResult devuelve únicamente la clave y las columnas sincronizadas.
Los credentials de Dynamics y Snowflake requieren un inicio de sesión en el navegador para completarse.

Estas limitaciones describen el comportamiento actual del producto, no cambios previstos.

Introducción

Autenticación

Convenciones

Mapa de la API

Ejemplo completo

Limitaciones conocidas

Véase también

¿Fue útil este artículo?

Artículo anterior

Artículo siguiente