S’authentifier et accéder aux API Experience Platform

Ce document fournit un tutoriel détaillé pour accéder à un compte de développeur Adobe Experience Platform afin d’effectuer des appels vers des API Experience Platform. À la fin de ce tutoriel, vous aurez généré ou collecté les informations d’identification suivantes, requises en tant qu’en-têtes dans tous les appels API Platform :

Pour préserver la sécurité de vos applications et de vos utilisateurs, toutes les requêtes envoyées aux API Experience Platform doivent être authentifiées et autorisées au moyen de normes telles qu’OAuth.

Ce tutoriel explique comment rassembler les informations d’identification requises pour authentifier les appels API Platform, comme indiqué dans le diagramme de flux ci-dessous. Vous pouvez rassembler la plupart des informations d’identification requises dans la configuration unique initiale. Toutefois, le jeton d’accès doit être actualisé toutes les 24 heures.

Conditions préalables prerequisites

Pour réussir les appels aux API Experience Platform, vous devez disposer des éléments suivants :

Vous devez également disposer d’une Adobe ID pour suivre ce tutoriel. Si vous ne possédez pas d’Adobe ID, vous pouvez en créer un en suivant les étapes suivantes :

Obtenir l’accès développeur et utilisateur pour l’Experience Platform gain-developer-user-access

Avant de créer des intégrations sur Adobe Developer Console, votre compte doit disposer des autorisations de développeur et d’utilisateur pour un profil de produit Experience Platform dans Adobe Admin Console.

Obtenir l’accès développeur gain-developer-access

Contactez un administrateur ou une administratrice Admin Console(e) de votre organisation pour vous ajouter en tant que développeur ou développeuse à un profil de produit Experience Platform. Consultez la documentation de l’Admin Console pour obtenir des instructions spécifiques sur la gestion de l’accès des développeurs pour les profils de produit.

Une fois que vous êtes affecté en tant que développeur, vous pouvez commencer à créer des intégrations dans Adobe Developer Console. Ces intégrations sont un pipeline allant des applications et services externes aux API d’Adobe.

Obtenir l’accès utilisateur gain-user-access

Votre administrateur Admin Console doit également vous ajouter en tant qu’utilisateur au même profil de produit. Avec un accès utilisateur, vous pouvez voir dans l’interface utilisateur le résultat des opérations de l’API que vous effectuez.

Pour plus d’informations, consultez le guide sur la gestion des groupes d’utilisateurs dans Admin Console.

Générer une clé API (identifiant client) et un identifiant d’organisation generate-credentials

Une fois que vous avez obtenu l’accès développeur et utilisateur à Platform par le biais de l’Admin Console, l’étape suivante consiste à générer vos informations d’identification {ORG_ID} et {API_KEY} dans Adobe Developer Console. Ces informations d’identification ne doivent être générées qu’une seule fois et peuvent être réutilisées dans les prochains appels API de Platform.

Ajouter un Experience Platform à un projet add-platform-to-project

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 dans l’écran Aperçu du projet.

Écran Developer Console

L’écran Ajouter une API s’affiche. Sélectionnez l’icône de produit pour Adobe Experience Platform, puis choisissez API Experience Platform avant de sélectionner Suivant.

.

Sélectionnez le type d’authentification OAuth de serveur à serveur select-oauth-server-to-server

Sélectionnez ensuite le type d’authentification OAuth serveur à serveur pour générer des jetons d’accès et accéder à l’API Experience Platform. Attribuez un nom significatif à vos informations d’identification dans le champ de texte Nom des informations d’identification avant de sélectionner Suivant.

Sélection des profils de produit pour votre intégration select-product-profiles

Dans l’écran Configurer l’API, sélectionnez AEP-Default-All-Users avec les profils de produit supplémentaires auxquels vous souhaitez accéder.

Sélectionnez Enregistrer l’API configurée lorsque vous êtes prêt.

Une présentation des étapes décrites ci-dessus pour configurer une intégration avec l’API Experience Platform est également disponible dans le tutoriel vidéo ci-dessous :

Collecter les informations d’identification gather-credentials

Une fois l’API ajoutée au projet, la page OAuth de serveur à serveur pour le projet affiche les informations d’identification suivantes, requises dans tous les appels aux API Experience Platform :

Générer un jeton d’accès generate-access-token

L’étape suivante consiste à générer des informations d’identification {ACCESS_TOKEN} à utiliser dans les appels API Platform. Contrairement aux valeurs de {API_KEY} et {ORG_ID}, un nouveau jeton doit être généré toutes les 24 heures pour continuer à utiliser les API Platform. Sélectionnez Générer un jeton d’accès qui génère votre jeton d’accès, comme illustré ci-dessous.

Créer et récupérer les informations d’authentification directement dans la documentation de référence de l’API get-credentials-functionality

À compter de la version de novembre 2024 d’Experience Platform, vous pouvez obtenir des informations d’identification pour utiliser les API Experience Platform directement à partir des pages de référence de l’API, sans avoir à accéder à Developer Console. Consultez l’exemple ci-dessous à partir de la page API Flow Service - Destinations.

Pour obtenir des informations d’identification pour appeler les API Platform, accédez à la page de référence des API de l’Experience Platform et sélectionnez Se connecter en haut de la page. Connectez-vous avec votre Compte personnel ou Compte d’entreprise ou d’école.

Après vous être connecté, sélectionnez Créer de nouvelles informations d’identification pour créer un ensemble d’informations d’identification afin d’accéder aux API Platform.

Ensuite, utilisez le sélecteur de liste déroulante pour ouvrir la fenêtre des informations d’identification, générer un jeton d’accès et obtenir votre clé API et votre identifiant d’organisation. Copiez les informations d’identification dans les blocs Essayer des pages de référence de l’API pour commencer à utiliser les API Platform.

[Obsolète]{class="badge informative"} Générer un jeton Web JSON (JWT) jwt

curl -X POST https://ims-na1.adobelogin.com/ims/exchange/jwt \
  -H 'Content-Type: multipart/form-data' \
  -F 'client_id={API_KEY}' \
  -F 'client_secret={SECRET}' \
  -F 'jwt_token={JWT}'

{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}

Tester les informations d’identification d’accès test-credentials

Une fois que vous avez rassemblé les trois informations d’identification requises (jeton d’accès, clé API et ID d’organisation), vous pouvez essayer d’effectuer l’appel API suivant. Cet appel répertorie toutes les classes Experience Data Model standard (XDM) disponibles pour votre organisation. Importez et exécutez l’appel dans Postman.

Requête

curl -X GET https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
  -H 'x-api-key: {{API_KEY}}' \
  -H 'x-gw-ims-org-id: {{ORG_ID}}'

Réponse

Si votre réponse est similaire à celle affichée ci-dessous, alors vos informations d’identification sont valides et fonctionnent. (Cette réponse a été tronquée pour l’espace.)

{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}

Obtenez les autorisations de contrôle d’accès basé sur les attributs nécessaires get-abac-permissions

Pour accéder à plusieurs ressources ou les modifier dans l’Experience Platform, vous devez disposer des autorisations de contrôle d’accès appropriées. Les administrateurs système peuvent vous accorder les autorisations dont vous avez besoin. Pour plus d’informations, reportez-vous à la section sur la gestion des informations d’identification d’API pour un rôle.

Vous trouverez également des informations détaillées sur la manière dont un administrateur système peut accorder les autorisations requises pour accéder aux ressources de Platform par le biais de l’API dans le tutoriel vidéo ci-dessous :

Utilisation de Postman pour authentifier et tester les appels API use-postman

Postman est un outil populaire qui permet aux développeurs d’explorer et de tester les API RESTful. Vous pouvez utiliser les collections et environnements Postman Experience Platform pour accélérer votre travail avec les API Experience Platform. En savoir plus sur l’utilisation de Postman dans Experience Platform et la prise en main des collections et des environnements.

Des informations détaillées sur l’utilisation de Postman avec des collections et des environnements Experience Platform sont également disponibles dans les tutoriels vidéo ci-dessous :

Télécharger et importer un environnement Postman à utiliser avec les API Experience Platform

Utiliser une collection Postman pour générer des jetons d’accès

Téléchargez la collection Identity Management Service Postman 🔗 et regardez la vidéo ci-dessous pour savoir comment générer des jetons d’accès.

Télécharger des collections Postman d’API Experience Platform et interagir avec les API

Administrateurs système : accordez au développeur et au contrôle d’accès aux API des autorisations Experience Platform grant-developer-and-api-access-control

Avant de pouvoir créer des intégrations sur Adobe Developer Console, votre compte doit disposer des autorisations de développeur et d’utilisateur pour un profil de produit Experience Platform.

Ajout de développeurs au profil de produit add-developers-to-product-profile

Accédez à l’Admin Console 🔗 et connectez-vous avec votre Adobe ID.

Sélectionnez Produits dans la barre de navigation, puis sélectionnez Adobe Experience Platform dans la liste des produits.

Dans l’onglet Profils de produit, sélectionnez AEP-Default-All-Users. Vous pouvez également utiliser la barre de recherche pour rechercher le profil de produit en saisissant le nom.

Sélectionnez l’onglet Développeurs, puis sélectionnez Ajouter un développeur.

La boîte de dialogue Ajouter des développeurs s’affiche. Saisissez l’adresse e-mail e-mail ou le nom d’utilisateur du développeur. Un e-mail ou nom d’utilisateur valide affiche les détails du développeur. Sélectionnez Enregistrer.

Le développeur a été ajouté avec succès et apparaît dans l’onglet Développeurs.

Attribution d’informations d’identification d’API à un rôle

Pour utiliser et effectuer des opérations sur des API Experience Platform, un administrateur système doit ajouter les informations d’identification d’API en plus du jeu d’autorisations donné d’un rôle. Pour plus d’informations, reportez-vous à la section sur la gestion des informations d’identification d’API pour un rôle.

Une présentation des étapes décrites ci-dessus pour ajouter des développeurs aux profils de produit et affecter des API aux rôles est également disponible dans le tutoriel vidéo ci-dessous :

Ressources supplémentaires additional-resources

Consultez les ressources supplémentaires ci-dessous pour obtenir de l’aide sur la prise en main des API Experience Platform

Étapes suivantes next-steps

En lisant ce document, vous avez rassemblé et testé avec succès vos informations d’identification d’accès pour les API Platform. Vous pouvez désormais suivre les exemples d’appels API fournis dans toute la documentation.

Outre les valeurs d’authentification que vous avez collectées dans ce tutoriel, de nombreuses API de Platform nécessitent également qu’un {SANDBOX_NAME} valide soit fourni comme en-tête. Pour plus d’informations, consultez la Présentation des sandbox.