Lecture d’exemples d’appels API

La documentation de l’API Real-Time Customer Profile fournit des exemples d’appels d’API pour démontrer comment formater correctement les 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 la 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épannageExperience Platform.

En-têtes requis

La documentation de l’API exige aussi que vous ayez suivi le tutoriel sur l’authentification pour lancer des appels vers des points d’entrée Experience Platform Le tutoriel sur l’authentification indique les valeurs de chacun des en-têtes requis dans les appels d’API Experience Platform, comme illustré 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. Les requêtes Experience Platform API nécessitent un en-tête spécifiant le nom du sandbox dans lequel l’opération aura lieu :

  • x-sandbox-name: {SANDBOX_NAME}

Pour plus d’informations sur les sandbox dans Experience Platform, consultez la documentation de présentation des sandbox.

Toutes les requêtes ayant un payload dans le corps de la requête (notamment les appels POST, PUT et PATCH) doivent comporter un en-tête Content-Type. Les valeurs acceptées propres à chaque appel sont fournies dans les paramètres d’appel.