Le backend DQE One pour Salesforce expose des API utilisées par le package Salesforce pour déclencher et gérer les processus backend — configuration des sources de données, exécution des jobs de fusion et d'audit, et gestion des sessions d'interface personnalisée intégrées au package.
L'API DQE One est différente des autres API DQE documentées dans ce centre d'aide : ce n'est pas un service public de recherche ou de validation appelé directement par vos propres applications. C'est le backend utilisé en interne par le package DQE One pour Salesforce — le package l'appelle (et un sous-ensemble d'endpoints est, à son tour, appelé par des services hébergés par DQE agissant pour le compte du package) pour récupérer la configuration de nettoyage des données, lancer des jobs backend, et gérer l'interface personnalisée du package. Cet article présente l'API dans son ensemble ; chaque autre article de cette famille documente en détail un domaine fonctionnel.
Modèle d'authentification
L'API DQE One définit deux schémas de sécurité distincts dans sa spécification OpenAPI. La plupart des endpoints exigent l'un des deux ; quelques-uns — comme la vérification de disponibilité ci-dessous — n'en exigent aucun.
| Schéma | Fonctionnement | Généralement utilisé pour |
|---|---|---|
| DQE-Authorization | Une clé API transmise dans un en-tête HTTP personnalisé nommé DQE-Authorization.
OpenAPI type: apiKey, in: header
|
La plupart des endpoints backend appelés par le package Salesforce — par exemple pour émettre un jeton de processus ou gérer la configuration des données. |
| bearerAuth | Un jeton Bearer JSON Web Token standard transmis dans l'en-tête Authorization, par exemple Authorization: Bearer {JWT}.
OpenAPI type: http, scheme: bearer, bearerFormat: JWT
|
Un sous-ensemble plus restreint d'endpoints de gestion de l'interface personnalisée. |
DQE-Authorization ou un JWT bearer en dehors des flux de jeton/abonnement décrits dans l'article Authentification et session n'a pas encore été documentée par l'équipe d'ingénierie DQE — vérifiez avec l'équipe avant publication si quelque chose ici doit être corrigé.Chaque endpoint déclare individuellement sa propre exigence. Consultez l'article Authentification et session pour les trois endpoints qui émettent ou consomment ces identifiants, et chaque article spécifique à un endpoint pour ce que cet endpoint particulier attend.
Articles de cette famille
L'API DQE One est documentée à travers cinq articles :
| Article | Couvre |
|---|---|
| Introduction | Cette page — vue d'ensemble, modèle d'authentification, et la vérification de disponibilité GET /echo. |
| Authentification et session |
POST /getOAuthTokenForProcess, POST /subscribe, POST /customUI/createTokenSession. |
| Data Configuration |
POST /getDCMetadata, POST /getFusionField, POST /createFusionLookup. |
| Jobs et audits |
POST /newJob, POST /launchAudit, POST /previewDataPrep. |
| Gestion de l'interface personnalisée |
POST /customUI/resetRules, POST /customUI/importRules. |
/lanchAudit (sic — semble être un doublon ou une faute de frappe de /launchAudit ; il n'a pas d'operationId et ne déclare aucun schéma de sécurité) et un corps de requête /newJob défini comme un $ref pointant vers le corps de requête propre à /lanchAudit plutôt que vers un schéma de composant partagé. Aucune de ces deux anomalies n'est traitée dans cette introduction — signalez les deux à l'équipe d'ingénierie DQE avant de documenter /newJob et /launchAudit.Vérification de disponibilité — GET /echo
Requête
Une simple vérification de disponibilité utilisée pour confirmer que le backend est accessible. Elle ne prend aucun paramètre et ne nécessite aucune authentification.
{DOMAIN} est le domaine du backend configuré pour votre instance du package DQE One. La spécification OpenAPI modélise cela comme une variable de serveur domain configurable plutôt que comme un hôte fixe unique.
Réponse
Renvoie un objet JSON fixe confirmant que le service est opérationnel.
| Clé | Description | Type |
|---|---|---|
| status | Valeur fixe confirmant que le backend est accessible. | String |
Exemple de réponse
Erreurs
La spécification source ne définit aucune réponse d'erreur pour cet endpoint.
Tester l'API
Cliquez sur le bouton ci-dessous pour tester cet endpoint en direct dans votre navigateur.
Ouvrir la console
Voir aussi
Associé à