Prise en main de l’API du Privacy Service

Ce guide présente les concepts de base que vous devez connaître avant de tenter d’appeler l’API du Privacy Service.

Conditions préalables

Ce guide nécessite une compréhension pratique des fonctionnalités suivantes :

  • Adobe Experience Platform Privacy Service: Fournit une API RESTful et une interface utilisateur qui vous permettent de gérer les demandes d'accès et de suppression de vos sujets de données (clients) dans les applications Adobe Experience Cloud.

Collecte des valeurs des en-têtes requis

Pour pouvoir appeler l’API du Privacy Service, vous devez d’abord recueillir vos informations 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 des autorisations de développeur pour Adobe Experience Platform dans Adobe Admin Console, puis de générer les informations d’identification dans Adobe Developer Console.

Obtenir l’accès en tant que développeur à Experience Platform

Pour obtenir l’accès des développeurs à Platform, suivez les premières étapes de la section Didacticiel sur l’authentification des Experience Platform. Une fois que vous êtes arrivé à l’étape "Générer des informations d’identification d’accès dans Adobe Developer Console", revenez à ce tutoriel pour générer les informations d’identification spécifiques au Privacy Service.

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

À 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}

Votre {IMS_ORG} et {API_KEY} doit être généré une seule fois et peut être réutilisé dans les prochains appels d’API. Toutefois, 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 tutoriel sur la création dʼun projet vide disponible dans la documentation dʼAdobe Developer Console.

Une fois que vous avez créé un projet, sélectionnez Ajouter une API sur Présentation du projet écran.

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

Le Configurer l’API s’affiche. Sélectionnez l’option pour Génération d’une paire de clés, puis sélectionnez Génération d’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électionner Enregistrer l’API configurée pour terminer la configuration.

Une fois que l’API a été ajoutée au projet, la page du projet s’affiche de nouveau dans le dossier Présentation de l’API Privacy Service . À partir de là, faites défiler la liste jusqu’à la Compte de service (JWT) qui fournit les informations d’identification d’accès suivantes requises dans tous les appels à l’API du Privacy Service :

  • ID CLIENT: L’ID client est le {API_KEY} pour cela doit être indiqué dans l'en-tête x-api-key.
  • ID D’ORGANISATION: L’ID d’organisation est le {IMS_ORG} 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 recueillir sont les suivantes : {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 Platform API.

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ération d’un jeton d’accès avant 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 d’autorisation requis et doit être fournie au format Bearer {ACCESS_TOKEN}.

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, consultez la section sur lecture d’exemples d’appels d’API dans le guide de prise en main des API de plate-forme.

Étapes suivantes

Maintenant que vous savez quels en-têtes utiliser, vous êtes prêt à commencer à lancer des appels à l’API Privacy Service. Sélectionnez l’un des repères de point de terminaison pour commencer :

Sur cette page