Show Menu
SUJETS×

Privacy Service guide du développeur

Adobe Experience Platform Privacy Service provides a RESTful API and user interface that allow you to manage (access and delete) the personal data of your data subjects (customers) across Adobe Experience Cloud applications. 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
This guide covers how to use the Privacy Service API. Pour plus d’informations sur l’utilisation de l’interface utilisateur, consultez la présentation de l’interface utilisateur de Privacy Service . For a comprehensive list of all available endpoints in the Privacy Service API, please see the API reference .

Prise en main

This guide requires a working understanding the following Experience Platform features:
  • Privacy Service : Fournit une API RESTful et une interface utilisateur qui vous permettent de gérer les requêtes d’accès et de suppression de vos données (clients) sur 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. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.

Collecte des valeurs des en-têtes requis

Pour appeler l’ Privacy Service API, vous devez d’abord rassembler vos informations d’identification d’accès pour les 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 les 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 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 la Console développeur d'Adobe", 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}
Vous {IMS_ORG} {API_KEY} devez générer votre fichier une seule fois et vous pouvez le réutiliser 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

Go to Adobe Developer Console and sign in with your 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 d'Adobes.
Une fois que vous avez créé un nouveau projet, cliquez sur Ajouter l’API dans l’écran Présentation du projet.
L’écran Ajouter une API s’affiche. Sélectionnez API ​Privacy Service dans la liste des API disponibles avant de cliquer sur Suivant .
The Configure API screen appears. Sélectionnez l’option Générer une paire de clés, puis cliquez sur 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 d'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’ Privacy Service API :
  • 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 les vôtres {ACCESS_TOKEN} , qui sont utilisées dans l’en-tête Autorisation. Contrairement aux valeurs pour {API_KEY} et {IMS_ORG} , un nouveau jeton doit être généré toutes les 24 heures pour continuer à utiliser Platform les API.
Pour générer un nouveau fichier {ACCESS_TOKEN} , ouvrez la clé privée précédemment téléchargée et collez son contenu dans la zone de texte en regard de Générer un jeton d'accès avant de cliquer sur Générer un 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

Now that you understand what headers to use, you are ready to begin making calls to the Privacy Service API. 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.