S’authentifier et accéder aux API Experience Platform

Ce document fournit un tutoriel détaillé permettant d’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 d’API Platform :

Pour maintenir la sécurité de vos applications et de vos utilisateurs, toutes les demandes aux API Experience Platform doivent être authentifiées et autorisées à l’aide de normes telles que OAuth.

Ce tutoriel explique comment rassembler les informations d’identification requises pour authentifier les appels API Platform, comme décrit dans l’organigramme ci-dessous. Vous pouvez rassembler la plupart des informations d’identification requises dans la configuration initiale unique. Le jeton d’accès doit toutefois être actualisé toutes les 24 heures.

Conditions préalables prerequisites

Pour passer avec succès des appels à des API Experience Platform, vous devez disposer des éléments suivants :

Vous devez également disposer d’un 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 un accès développeur et utilisateur pour les 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 un accès en tant que développeur gain-developer-access

Contactez un administrateur Admin Console de votre entreprise pour vous ajouter en tant que développeur à un profil de produit Experience Platform à l’aide de Admin Console. Consultez la documentation Admin Console pour obtenir des instructions spécifiques sur la gestion de l’accès des développeurs pour les profils de produits.

Une fois que vous avez été affecté en tant que développeur, vous pouvez commencer à créer des intégrations dans Adobe Developer Console. Ces intégrations constituent un pipeline allant des applications et services externes vers les API d’Adobe.

Obtenir un 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 l’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ération d’une clé API (ID client) et d’un ID d’organisation generate-credentials

Une fois que vous avez reçu un accès utilisateur et développeur à Platform via 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 futurs appels d’API 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 sur l’écran Project Overview (Aperçu du projet).

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

Sélectionnez le type d'authentification OAuth Server-to-Server select-oauth-server-to-server

Sélectionnez ensuite le type d'authentification OAuth Server-to-Server pour générer des jetons d'accès et accéder à l'API Experience Platform.

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.

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 :

Collecte des informations d’identification gather-credentials

Une fois que l’API a été ajoutée au projet, la page API Experience Platform du 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 d’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, comme illustré ci-dessous.

Création et récupération des 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 de Platform, accédez à une page de référence des API 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.

Une fois connecté, sélectionnez Créer de nouvelles informations d’identification pour créer un nouvel ensemble d’informations d’identification permettant 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é d’API et votre ID d’organisation. Copiez les informations d’identification dans les blocs Essayez-le 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’accès test-credentials

Une fois que vous avez rassemblé les trois informations d’identification requises - jeton d’accès, clé d’API et ID d’organisation - , vous pouvez effectuer l’appel API suivant. Cet appel répertorie toutes les classes Experience Data Model (XDM) standard 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 illustrée ci-dessous, 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"
    }
  ]
}

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

Pour accéder à plusieurs ressources ou les modifier dans 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 de l’API pour un rôle.

Des informations détaillées sur la manière dont un administrateur système peut accorder les autorisations requises pour accéder aux ressources Platform via l’API sont également disponibles 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 Postman Identity Management Service et regardez la vidéo ci-dessous pour découvrir 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 : octroi aux développeurs et aux API d’un contrôle d’accès avec des autorisations d’Experience Platform grant-developer-and-api-access-control

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.

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

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

Sélectionnez Produits, puis 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 son nom.

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

Saisissez le Email ou nom d’utilisateur du développeur. Un email 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 sur l’onglet Développeurs .

Attribution d’une API à un rôle

Un administrateur système peut affecter des API aux rôles dans l’interface utilisateur de l’Experience Platform.

Sélectionnez Permissions et le rôle auquel vous souhaitez ajouter l’API. Sélectionnez l’onglet Informations d’identification de l’API, puis sélectionnez Ajouter les informations d’identification de l’API.

Sélectionnez l’API que vous souhaitez ajouter au rôle, puis sélectionnez Enregistrer.

Vous revenez à l’onglet Informations d’identification de l’API, où l’API nouvellement ajoutée est répertoriée.

Ressources supplémentaires additional-resources

Reportez-vous aux ressources supplémentaires liées ci-dessous pour plus d’informations 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 la documentation.

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