Einführung

Einführung - DQE One Standalone API

Mit der DQE One Standalone API steuern Sie Ihren selbst gehosteten DQE One Standalone Server per Fernzugriff: Dateien hochladen, Datenquellen verbinden, Data-Quality-Processes erstellen und ausführen, deren Runs verfolgen und RuleSets verwalten — alles, was Sie in der Weboberfläche tun können, um die Stapelverarbeitung zu automatisieren.

{DOMAIN} ist der Hostname Ihres eigenen DQE One Standalone Servers — er wird selbst gehostet, daher hängt dieser Wert von Ihrer Bereitstellung ab. {EMAIL} ist Ihr DQE One Login und {API_TOKEN} der Token, der unter My Account > API Token generiert wird.

Nicht Gegenstand dieses Artikels: die Echtzeit-API für die Duplikatsuche (Use the Lookup API in DQE One Standalone) und der MCP-Server für KI-Assistenten (DQE One Standalone — MCP server).

Direkt zuAuthentifizierung Konventionen API-Übersicht Durchgängiges Beispiel Einschränkungen

Authentifizierung

Jeder Endpoint verwendet die HTTP-Basic-Authentifizierung: Ihre DQE One E-Mail-Adresse als Benutzername und Ihr API token als Passwort (Authorization: Basic base64(email:api_token); mit curl -u "email:token"). Sitzungen, Bearer-Token oder OAuth werden auf diesen Routen nicht akzeptiert.

Melden Sie sich in der Weboberfläche von DQE One Standalone an.
Öffnen Sie My Account und den Bereich API Token und generieren Sie dann den Token.
Verwenden Sie ihn als Basic-Passwort. Wenn Sie ihn neu generieren, wird der vorherige ungültig.

Behandeln Sie den Token wie ein Passwort. Er läuft nie ab, hat keine Scopes und gewährt vollen Zugriff auf alles, was Ihrem Konto gehört (Dateien, Credential-Metadaten, Processes, RuleSets). Halten Sie ihn aus der Versionsverwaltung und aus Logs heraus. Wie Sie ihn erneuern, lesen Sie unter Manage your profile in DQE One Standalone.

Konventionen

Thema	Verhalten
Basis-URL	`https://{DOMAIN}/api/...` — DQE One Standalone wird selbst gehostet, daher ist `{DOMAIN}` Ihr eigener Server.
Benutzerzuordnung	Alles ist auf den authentifizierten Benutzer beschränkt. Die ID eines anderen Benutzers liefert 404, niemals 403.
Erfolg	`{"status":"success", ...}`. Listen sind reine JSON-Arrays. Endpoints zum Erstellen antworten mit 201, auch `updateProcess`.
Fehler	`{"status":"error","error":"<message>"}` auf Englisch. Ausnahmen sind beim jeweiligen Endpoint vermerkt (zum Beispiel verwendet `runProcess` `message`, und der RuleSet-Import liefert `error` als Liste).
401	`{"status":"error","error":"Unauthorized"}` bei fehlenden, falschen oder unbekannten Zugangsdaten. Ein fehlerhafter Header (kein Base64 oder ohne `:`) kann stattdessen einen unformatierten 500-Fehler auslösen.
Methoden	Eine falsche Methode wird mit 405 beantwortet. `runProcess` und `deleteProcess` sind GET-Anfragen, die Daten verändern.
Asynchrone Verarbeitung	`runProcess` stellt den Run nur in die Warteschlange. Fragen Sie `getRuns` regelmäßig ab. Jobs laufen pro Benutzer nacheinander.
Unformatierter 500-Fehler	Einige Eingaben (eine nicht numerische `id`, ein Process, der nie ausgeführt wurde) lösen statt JSON einen einfachen Serverfehler aus. Validieren Sie IDs auf Ihrer Seite.
Limits	Kein Rate Limiting, keine Paginierung, keine explizite Größenbeschränkung für Uploads, Tokens laufen nie ab. CORS ist für jeden Origin offen (die Autorisierung ergibt sich aus dem Authorization-Header).
Interaktive Dokumentation	Ihr Server stellt außerdem ReDoc unter `/doc/` und Swagger UI unter `/doc/swagger/` bereit. Diese sind nicht vollständig korrekt (Schlüsselnamen, Statuscodes, Array- vs. Objekt-Antworten): Bevorzugen Sie diese Dokumentation und die oben genannte OpenAPI-Datei.

API-Übersicht

Artikel	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	Dieselben Operationen für KI-Assistenten (Claude und andere MCP-Clients): JSON-RPC unter `/mcp`.

Sie suchen die Echtzeit-Duplikatsuche? Dafür gibt es eine separate API: Use the Lookup API in DQE One Standalone.

Durchgängiges Beispiel

Dieser vollständige Ablauf benötigt nichts weiter als eine CSV-Datei. Für eine Datenbank- oder CRM-Quelle erstellen Sie zuerst ein Credential (Credentials) und verwenden "source":"postgres", "object":"<table>", "credential":<id> anstelle von 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"
          

Die Reihenfolge beim Aufräumen ist wichtig: Löschen Sie zuerst den Process (sobald sein Run Finished oder Failed ist), dann das Credential und danach die Datei; jedes davon wird mit 423 abgelehnt, solange es noch verwendet wird.

Bekannte Einschränkungen

Processes vom Typ find_and_replace, format und audit lassen sich über die API nicht zuverlässig erstellen, und Snowflake-Processes scheitern immer an der Validierung: Verwenden Sie dafür die Weboberfläche.
updateProcess kann einen booleschen Wert nicht wieder auf false setzen und setzt die Felder zurück, die Sie nicht mitsenden.
Es gibt keinen Endpoint zum Abbrechen eines Runs, und getProcessResult liefert nur den Schlüssel und die synchronisierten Spalten.
Dynamics- und Snowflake-Credentials benötigen zum Abschluss eine Anmeldung im Browser.

Diese Punkte beschreiben das aktuelle Verhalten des Produkts, keine geplanten Änderungen.

Einführung

Authentifizierung

Konventionen

API-Übersicht

Durchgängiges Beispiel

Bekannte Einschränkungen

Siehe auch

War dieser Beitrag hilfreich?

Vorheriger Artikel

Nächster Artikel