S’authentifier et accéder à l’API Privacy Service
Ce guide présente les concepts de base que vous devez connaître avant d’effectuer des appels vers l’API Adobe Experience Platform Privacy Service.
Conditions préalables prerequisites
Ce guide nécessite une compréhension pratique de Privacy Service et la manière dont il vous permet de gérer les requêtes d’accès et de suppression de vos sujets des données (clients) dans les applications Adobe Experience Cloud.
Afin de créer des informations d’identification d’accès pour l’API, un administrateur de votre entreprise doit avoir préalablement configuré les profils de produit pour Privacy Service dans Adobe Admin Console. Le profil de produit que vous affectez à une intégration d’API détermine les autorisations dont dispose l’intégration lors de l’accès aux fonctionnalités de Privacy Service. Consultez le guide sur la gestion des autorisations de Privacy Service pour plus d’informations.
Collecter des valeurs pour les en-têtes requis gather-values-required-headers
Pour passer des appels à l’API du 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: {ORG_ID}
Ces valeurs sont générées à l’aide de Console Adobe Developer. Votre {ORG_ID} et {API_KEY} ne doit être généré qu’une seule fois et peut être réutilisé dans les prochains appels 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 one-time-setup
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 dans la documentation de Developer Console.
Une fois que vous avez créé un projet, sélectionnez Ajouter au projet et choisissez API dans le menu déroulant.
Sélection de l’API du Privacy Service select-privacy-service-api
L’écran Ajouter une API s’affiche. Sélectionner Experience Cloud pour réduire la liste des API disponibles, puis sélectionnez la carte pour API PRIVACY SERVICE avant de sélectionner Suivant.
Sélectionnez ensuite le type d'authentification pour générer les jetons d'accès et accéder à l'API du Privacy Service.
Attribution d’autorisations via les profils de produit product-profiles
La dernière étape de configuration consiste à sélectionner les profils de produit à partir desquels cette intégration héritera de ses autorisations. Si vous sélectionnez plusieurs profils, leurs jeux d’autorisations seront combinés pour l’intégration.
Lorsque vous avez terminé, sélectionnez Enregistrer l’API configurée.
Une fois l’API ajoutée au projet, la variable API PRIVACY SERVICE La page du projet affiche les informations d’identification suivantes, requises dans tous les appels aux API du Privacy Service :
{API_KEY}(ID client){ORG_ID}(ID d’organisation)
Authentification pour chaque session authentication-each-session
Les dernières informations d’identification requises que vous devez recueillir sont vos {ACCESS_TOKEN}, qui est utilisé dans l’en-tête d’autorisation. Contrairement aux valeurs de {API_KEY} et {ORG_ID}, un nouveau jeton doit être généré toutes les 24 heures pour continuer à utiliser l’API.
En règle générale, il existe deux méthodes pour générer un jeton d’accès :
- Génération manuelle du jeton pour les tests et le développement.
- Automatiser la génération des jetons pour les intégrations d’API.
Génération manuelle d’un jeton manual-token
Pour générer manuellement une nouvelle {ACCESS_TOKEN}, accédez à Informations d’identification > OAuth serveur à serveur et sélectionnez Générer un jeton d’accès, comme illustré ci-dessous.
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 Authorization requis et doit être fournie au format Bearer {ACCESS_TOKEN}.
Automatiser la génération des jetons auto-token
Vous pouvez également utiliser un environnement et une collection Postman pour générer des jetons d’accès. Pour plus d’informations, consultez la section sur utilisation de Postman pour authentifier et tester les appels API dans le guide d’authentification de l’API Experience Platform.
Lecture d’exemples d’appels API read-sample-api-calls
Chaque guide de point de terminaison 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 API, consultez la section sur lecture d’exemples d’appels API dans le guide de prise en main des API Platform.
Étapes suivantes next-steps
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 guides de point d’entrée pour commencer :