Prise en main de l’API Policy Service

L’API Policy Service vous permet de créer et de gérer diverses ressources liées à la Data Governance d’Adobe Experience Platform. Ce document présente les concepts de base que vous devez connaître avant d’effectuer des appels à l’API Policy Service.

Conditions préalables

L’utilisation du guide du développement nécessite une bonne compréhension des différents services Experience Platform impliqués dans l’utilisation des fonctionnalités de gouvernance des données. Avant de commencer à travailler avec les Policy Service API, consultez la documentation relative aux services suivants :

  • Data Governance : cadre selon lequel Experience Platform applique la conformité d’utilisation des données.
  • Experience Data Model (XDM) System : Cadre normalisé selon lequel Experience Platform organise les données de l’expérience client.
  • Real-time Customer Profile : fournit un profil client en temps réel unifié basé sur des données agrégées issues de plusieurs sources.
  • Environnements de test : Experience Platform fournit des environnements de test virtuels qui divisent une instance Platform unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience numérique.

Lecture d’exemples d’appels API

La documentation de l’API Policy Service inclut des exemples d’appels d’API expliquant 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.

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 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: {IMS_ORG}

Toutes les ressources qui se trouvent dans Experience Platform, y compris celles liées à la Data Governance, 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

Ressources de base ou personnalisées

Dans l’API Policy Service, toutes les stratégies et actions marketing sont nommées ressources core ou custom.

Les ressources core sont celles définies et gérées par Adobe, tandis que les ressources custom sont celles créées et gérées par votre organisation. Ces dernières sont donc uniques et visibles uniquement par votre organisation IMS. Les opérations de liste et de recherche (GET) sont donc les seules opérations autorisées sur les ressources core, alors que les opérations de liste, de recherche et de mise à jour (POST, PUT, PATCH et DELETE) sont disponibles pour les ressources custom.

Étapes suivantes

Pour commencer à effectuer des appels à l’aide de l’API Policy Service, sélectionnez l’un des guides de point d’entrée disponibles.

Sur cette page