Guide de l’API Identity Service

Adobe Experience Platform Identity Service gère l’identification inter-appareils, cross-canal et en temps quasi réel de vos clients dans ce qu’on appelle un graphique d’identités dans Adobe Experience Platform.

Prise en main

Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :

  • Identity Service : résout le problème fondamental posé par la fragmentation des données de profil des clients. Pour ce faire, il rapproche les identités entre les appareils et les systèmes sur lesquels les clients interagissent avec votre marque.
  • 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.
  • Experience Data Model (XDM) : cadre normalisé selon lequel Platform organise les données de l’expérience client.

Les sections suivantes apportent des informations supplémentaires que vous devrez connaître ou dont vous devrez disposer pour passer avec succès des appels à l’API Identity Service.

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 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.

Collecte des valeurs des en-têtes requis

Pour lancer des appels aux API 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 Experience Platform, comme indiqué ci-dessous :

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

Dans Experience Platform, toutes les ressources sont isolées dans des environnements de test virtuels spécifiques. Toutes les requêtes envoyées aux API Platform nécessitent un en-tête spécifiant le nom de l’environnement de test dans lequel l’opération sera effectuée :

  • x-sandbox-name : {SANDBOX_NAME}
REMARQUE

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

Toutes les requêtes contenant un payload (POST, PUT, PATCH) requièrent un en-tête supplémentaire :

  • Content-Type: application/json

Acheminement basé sur la région

L’API Identity Service utilise des points de terminaison spécifiques à une région qui nécessitent l’inclusion d’une balise {REGION} dans le chemin de requête. Pendant la mise en service de votre organisation IMS, une région est déterminée et stockée dans votre profil d’organisation IMS. L’utilisation de la région appropriée avec chaque point de terminaison garantit que toutes les requêtes effectuées à l’aide de l’API Identity Service sont acheminées vers la région appropriée.

Il existe actuellement deux régions prises en charge par les API Identity Service : VA7 et NLD2.

Le tableau ci-dessous présente des exemples de chemins qui utilisent les régions :

Service Région : VA7 Région : NLD2
Identity Service API https://platform-va7.adobe.io/data/core/identity/ https://platform-nld2.adobe.io/data/core/identity/
Identity Namespace API https://platform-va7.adobe.io/data/core/idnamespace/ https://platform-nld2.adobe.io/data/core/idnamespace
REMARQUE

Les requêtes effectuées sans spécifier de région peuvent entraîner le routage des appels vers une région incorrecte ou entraîner l’échec inattendu des appels.

Si vous ne parvenez pas à localiser la région dans votre profil d’organisation IMS, contactez votre administrateur système pour obtenir de l’aide.

Utilisation de l’API Identity Service

Les paramètres d’identité utilisés dans ces services peuvent être exprimés de l’une des deux manières suivantes : composite ou XID.

Les identités composites sont des éléments incluant à la fois la valeur d’identifiant et l’espace de noms. Lors de l’utilisation d’identités composites, l’espace de noms peut être fourni soit par nom (namespace.code), soit par identifiant (namespace.id).

Lorsqu’une identité est conservée, Identity Service génère et affecte un identifiant à cette identité, appelé identifiant natif, ou XID. Toutes les variations des API de cluster et de mappage prennent en charge les identités composites et les XID dans leurs requêtes et leurs réponses. L’un des paramètres est requis pour utiliser ces API : xid ou une combinaison de [ns ou nsid] et id.

Pour limiter le payload dans les réponses, les API adaptent leurs réponses au type de construction d’identité utilisée. En d’autres termes, si vous transmettez un XID, vos réponses auront des XID, si vous transmettez des identités composites, la réponse suivra la structure utilisée dans la requête.

Les exemples de ce document ne couvrent pas la fonctionnalité complète de l’API Identity Service. Pour l’API complète, voir le guide de référence de l’API Swagger.

REMARQUE

Toutes les identités renvoyées seront compilées dans un formulaire XID natif lorsque le XID natif est utilisé dans la requête. Il est recommandé d’utiliser le formulaire d’identifiant ou d’espace de noms. Pour plus d’informations, voir la section relative à l’obtention du XID d’une identité.

Étapes suivantes

Maintenant que vous avez collecté les informations d’identification requises, vous pouvez passer au reste du guide de développement. Chaque section fournit des informations importantes sur les points de terminaison et inclut des exemples d’appels API pour effectuer des opérations CRUD. Chaque appel comprend le format général de l’API, un exemple de requête montrant les en-têtes requis et les payloads correctement formatés, ainsi qu’un exemple de réponse pour un appel réussi.

Sur cette page