Privacy Service Guide de l’API

Adobe Experience Platform Privacy Service fournit une API RESTful et une interface utilisateur qui vous permettent de gérer (d'accéder et de supprimer) les données personnelles de vos personnes de données (clients) à travers les applications Adobe Experience Cloud. Privacy Service fournit aussi un mécanisme central d’audit et de connexion qui vous permet d’accéder à l’état et aux résultats des tâches impliquant des applications Experience Cloud

Ce guide explique comment utiliser l'API Privacy Service. Pour plus d’informations sur l’utilisation de l’interface utilisateur, consultez la présentation de l’interface utilisateur de Privacy Service. Pour obtenir une liste complète de tous les points de terminaison disponibles dans l'API Privacy Service, consultez la référence API.

Prise en main

Ce guide nécessite une bonne compréhension des fonctionnalités Experience Platform suivantes :

  • Privacy Service : fournit une API RESTful et une interface utilisateur permettant de gérer l’accès et de supprimer les requêtes des propriétaires des données (les clients) dans les applications Adobe Experience Cloud.

Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour passer avec succès des appels à l’API Privacy Service.

Lecture d’exemples d’appels API

Ce tutoriel 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 appeler l'API Privacy Service, vous devez d'abord rassembler vos informations d'identification d'accès à utiliser dans les en-têtes requis :

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

Cela implique d'obtenir des autorisations de développeur pour Experience Platform dans Adobe Admin Console, puis de générer les informations d'identification dans Adobe Developer Console.

Accédez à Experience Platform pour les développeurs

Pour permettre aux développeurs d'accéder à Platform, suivez les premières étapes du didacticiel d'authentification des Experience Platform. Une fois que vous êtes arrivé à l'étape "Générer les informations d'identification d'accès dans Adobe Developer Console", revenez à ce didacticiel pour générer les informations d'identification spécifiques à Privacy Service.

Générer des informations d’identification d’accès

A l’aide d’Adobe Developer Console, vous devez générer les trois informations d’identification d’accès suivantes :

  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}

Vos {IMS_ORG} et {API_KEY} n'ont besoin d'être générés qu'une seule fois et peuvent être réutilisés dans les prochains appels d'API. Cependant, votre {ACCESS_TOKEN} est temporaire et doit être régénéré toutes les 24 heures.

Les étapes de génération de ces valeurs sont décrites en détail ci-dessous.

Configuration ponctuelle

Accédez à Adobe Developer Console et connectez-vous avec votre Adobe ID. Suivez ensuite les étapes décrites dans le didacticiel sur la création d'un projet vide dans la documentation de la Console développeur de l'Adobe.

Après avoir créé un nouveau projet, sélectionnez Ajouter l'API dans l'écran Présentation du projet.

L'écran Ajouter une API s'affiche. Sélectionnez API du Privacy Service dans la liste des API disponibles avant de sélectionner Suivant.

L'écran Configurer l'API s'affiche. Sélectionnez l’option Générer une paire de clés, puis sélectionnez Générer une paire de clés dans le coin inférieur droit.

La paire de clés est générée automatiquement et un fichier ZIP contenant une clé privée et un certificat public est téléchargé sur votre ordinateur local (à utiliser ultérieurement). Sélectionnez Enregistrer l'API configurée pour terminer la configuration.

Une fois l'API ajoutée au projet, la page du projet réapparaît sur la page Aperçu de l'API du Privacy Service. À partir de là, faites défiler l'écran jusqu'à la section Compte de service (JWT), qui fournit les informations d'identification d'accès suivantes requises dans tous les appels à l'API Privacy Service :

  • ID CLIENT : L’ID client est requis {API_KEY} pour cela et doit être fourni dans l’en-tête x-api-key.
  • ID D'ORGANISATION : L’ID d’organisation est la {IMS_ORG} valeur qui doit être utilisée dans l’en-tête x-gw-ims-org-id.

Authentification pour chaque session

Les dernières informations d’identification requises que vous devez rassembler sont votre {ACCESS_TOKEN}, qui est utilisé dans l’en-tête Autorisation. Contrairement aux valeurs de {API_KEY} et {IMS_ORG}, un nouveau jeton doit être généré toutes les 24 heures pour continuer à utiliser les API Platform.

Pour générer un nouveau {ACCESS_TOKEN}, ouvrez la clé privée précédemment téléchargée et collez son contenu dans la zone de texte située en regard de Générer le jeton d'accès avant de sélectionner Générer le jeton.

Un nouveau jeton d'accès est généré et un bouton permettant de copier le jeton dans le Presse-papiers est fourni. Cette valeur est utilisée pour l'en-tête Autorisation requis et doit être fournie au format Bearer {ACCESS_TOKEN}.

Étapes suivantes

Maintenant que vous savez quels en-têtes utiliser, vous êtes prêt à commencer à lancer des appels à l'API Privacy Service. Le document sur les tâches liées à la confidentialité décrit les différents appels API que vous pouvez lancer à l’aide de l’API Privacy 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.

Sur cette page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free