Prise en main de l’API Real-time Customer Profile

Les points de terminaison de l’API Profil client en temps réel vous permettent d’effectuer des opérations CRUD de base sur des données de Profil, telles que la configuration d’attributs calculés, l’accès aux entités, l’exportation de données de Profil et la suppression de jeux de données ou de lots inutiles.

L'utilisation du guide du développeur nécessite une compréhension pratique des différents services Adobe Experience Platform impliqués dans l'utilisation de Profile données. Avant de commencer à travailler avec l'API Real-time Customer Profile, consultez la documentation relative aux services suivants :

  • Real-time Customer Profile: Fournit un profil client unifié en temps réel basé sur des données agrégées provenant de plusieurs sources.
  • Adobe Experience Platform Identity Service: Obtenez une meilleure vue de vos clients et de leur comportement en rapprochant les identités entre les périphériques et les systèmes.
  • Adobe Experience Platform Segmentation Service : permet de créer des segments d’audience à partir de données Real-time Customer Profile.
  • Experience Data Model (XDM): Cadre normalisé selon lequel la plate-forme organise les données d’expérience client.
  • Sandboxes: Experience Platform fournit des sandbox virtuels qui partitionnent une Platform instance unique en environnements virtuels distincts pour aider à développer et à développer des applications d'expérience numérique.

Les sections suivantes contiennent des informations supplémentaires que vous devez connaître pour pouvoir invoquer les points de terminaison de l'API Profile.

Lecture d’exemples d’appels API

La documentation de l'API Real-time Customer Profile fournit des exemples d'appels d'API pour 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 de terminaison Platform Le didacticiel d'authentification fournit les valeurs de chacun des en-têtes requis dans les appels d'API Experience Platform, comme indiqué ci-dessous :

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Toutes les ressources de Experience Platform sont isolées dans des sandbox virtuels spécifiques. Les requêtes d'API Platform 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 Platform, consultez la documentation d'aperçu de 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.

Étapes suivantes

Pour commencer à effectuer des appels à l'aide de l'API Real-time Customer Profile, sélectionnez l'un des guides de points de terminaison disponibles.

Sur cette page