Guide de l’API Query Service
Ce guide de développement décrit les étapes à suivre pour effectuer diverses opérations dans l’API Query Service d’Adobe Experience Platform.
Prise en main
Ce guide nécessite une compréhension pratique des divers services Adobe Experience Platform impliqués dans l’utilisation de Query Service.
- Query Service : permet de soumettre des requêtes aux jeux de données et de capturer les requêtes résultantes sous forme de nouveaux jeux de données dans Experience Platform.
- Experience Data Model (XDM) System : cadre normalisé selon lequel Experience Platform organise les données de l’expérience client.
- Sandboxes : Experience Platform fournit des sandbox virtuels qui divisent une instance Platform unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience digitale.
Les sections suivantes contiennent des informations supplémentaires que vous devez connaître pour utiliser correctement Query Service à l’aide de l’API.
Lecture d’exemples d’appels API
Ce guide fournit des exemples d’appels API pour démontrer comment formater vos requêtes. Il s’agit notamment de chemins d’accès, d’en-têtes requis et de payloads de requêtes correctement formatés. L’exemple JSON renvoyé dans les réponses de l’API est également fourni. Pour plus d’informations sur les conventions utilisées dans cette documentation pour les exemples d’appels d’API, voir la section concernant la lecture d’exemples d’appels d’API dans le guide de dépannage Experience Platform.
Collecte des valeurs des en-têtes requis
Pour lancer des appels aux API Experience Platform, vous devez d’abord suivre le tutoriel d’authentification. Le tutoriel d’authentification fournit les valeurs de chacun des en-têtes requis dans tous les appels d’API Platform, comme indiqué ci-dessous :
- Authorization:
Bearer {ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id :
{ORG_ID}
Dans Experience Platform, toutes les ressources sont isolées dans des sandbox virtuels spécifiques. Toutes les requêtes envoyées aux API Platform nécessitent un en-tête spécifiant le nom du sandbox dans lequel l’opération sera effectuée :
- x-sandbox-name :
{SANDBOX_NAME}
Exemples d’appels API
Maintenant que vous savez quels en-têtes utiliser, vous êtes prêt(e) à commencer à lancer des appels à l’API Query Service. Les documents suivants décrivent les différents appels API que vous pouvez effectuer à l’aide de l’API Query Service. Chaque appel d’exemple inclut le format général de l’API, un exemple de requête présentant les en-têtes requis et un exemple de réponse.
Étapes suivantes
Maintenant que vous avez appris à lancer des appels à l’aide de l’API Query Service, vous pouvez créer vos propres requêtes non interactives. Pour plus d’informations sur la création de requêtes, veuillez lire le guide de référence SQL.