Das DQE One-Backend für Salesforce stellt APIs bereit, die vom Salesforce-Paket verwendet werden, um Backend-Prozesse auszulösen und zu verwalten — Konfiguration von Datenquellen, Ausführung von Merge- und Audit-Jobs sowie Verwaltung der im Paket eingebetteten Custom-UI-Sitzungen.
Die DQE One API unterscheidet sich von den anderen in diesem Help Center dokumentierten DQE-APIs: Sie ist kein öffentlicher Lookup- oder Validierungsdienst, der direkt von Ihren eigenen Anwendungen aufgerufen wird. Sie ist das Backend, das intern vom DQE One-Paket für Salesforce verwendet wird — das Paket ruft sie auf (und ein Teil der Endpunkte wird wiederum von DQE-gehosteten Diensten aufgerufen, die im Auftrag des Pakets handeln), um Konfigurationen zur Datenbereinigung abzurufen, Backend-Jobs zu starten und die Custom-UI des Pakets zu verwalten. Dieser Artikel stellt die API als Ganzes vor; jeder andere Artikel dieser Familie dokumentiert einen Funktionsbereich im Detail.
Authentifizierungsmodell
Die DQE One API definiert zwei getrennte Sicherheitsschemata in ihrer OpenAPI-Spezifikation. Die meisten Endpunkte erfordern eines der beiden; einige — wie die unten stehende Verfügbarkeitsprüfung — erfordern keines von beiden.
| Schema | Funktionsweise | Typischerweise verwendet für |
|---|---|---|
| DQE-Authorization | Ein API-Schlüssel, der in einem benutzerdefinierten HTTP-Header namens DQE-Authorization übergeben wird.
OpenAPI type: apiKey, in: header
|
Die meisten Backend-Endpunkte, die vom Salesforce-Paket aufgerufen werden — zum Beispiel zur Ausstellung eines Prozess-Tokens oder zur Verwaltung der Datenkonfiguration. |
| bearerAuth | Ein Standard-Bearer-JSON-Web-Token, das im Authorization-Header übergeben wird, z. B. Authorization: Bearer {JWT}.
OpenAPI type: http, scheme: bearer, bearerFormat: JWT
|
Eine kleinere Gruppe von Endpunkten zur Custom-UI-Verwaltung. |
DQE-Authorization-Schlüssel oder ein Bearer-JWT außerhalb der im Artikel „Authentifizierung & Sitzung" beschriebenen Token-/Abonnement-Abläufe erlangt wird, wurde vom DQE-Engineering-Team noch nicht dokumentiert — vor der Veröffentlichung mit dem Team abstimmen, falls hier etwas korrigiert werden muss.Jeder Endpunkt legt seine eigene Anforderung individuell fest. Die drei Endpunkte, die diese Anmeldedaten ausstellen oder verwenden, finden Sie im Artikel Authentifizierung & Sitzung; was der jeweilige Endpunkt konkret erwartet, steht im entsprechenden endpunktspezifischen Artikel.
Artikel in dieser Familie
Die DQE One API ist über fünf Artikel hinweg dokumentiert:
| Artikel | Umfasst |
|---|---|
| Einführung | Diese Seite — Überblick, Authentifizierungsmodell und die Verfügbarkeitsprüfung GET /echo. |
| Authentifizierung & Sitzung |
POST /getOAuthTokenForProcess, POST /subscribe, POST /customUI/createTokenSession. |
| Datenkonfiguration |
POST /getDCMetadata, POST /getFusionField, POST /createFusionLookup. |
| Jobs & Audits |
POST /newJob, POST /launchAudit, POST /previewDataPrep. |
| Custom-UI-Verwaltung |
POST /customUI/resetRules, POST /customUI/importRules. |
/lanchAudit (sic — scheint ein Duplikat oder ein Schreibfehler von /launchAudit zu sein; er hat keine operationId und definiert kein Sicherheitsschema) sowie einen Request-Body für /newJob, der als $ref definiert ist, die auf den eigenen Request-Body von /lanchAudit verweist, statt auf ein gemeinsames Komponentenschema. Keine der beiden Auffälligkeiten wird in dieser Einführung behandelt — beide vor der Dokumentation von /newJob und /launchAudit mit dem DQE-Engineering-Team klären.Verfügbarkeitsprüfung — GET /echo
Anfrage
Eine einfache Verfügbarkeitsprüfung, mit der bestätigt wird, dass das Backend erreichbar ist. Sie benötigt keine Parameter und erfordert keine Authentifizierung.
{DOMAIN} ist die für Ihre DQE One-Paketinstanz konfigurierte Backend-Domain. Die OpenAPI-Spezifikation modelliert dies als konfigurierbare Server-Variable domain statt als einen einzigen festen Host.
Antwort
Gibt ein festes JSON-Objekt zurück, das bestätigt, dass der Dienst verfügbar ist.
| Schlüssel | Beschreibung | Typ |
|---|---|---|
| status | Fester Wert, der bestätigt, dass das Backend erreichbar ist. | String |
Beispielantwort
Fehler
Die Quellspezifikation definiert für diesen Endpunkt keine Fehlerantworten.
API testen
Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.
Konsole öffnen
Siehe auch
Verknüpfung mit