S’authentifier et accéder à l’API Reactor

Pour utiliser la variable API Reactor pour créer et gérer les extensions Balises, chaque requête doit inclure les en-têtes d’authentification suivants :

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Ce guide explique comment utiliser Adobe Developer Console pour rassembler les valeurs de chacun de ces en-têtes afin que vous puissiez commencer à lancer des appels vers l’API Reactor.

Obtenir l’accès développeur à Adobe Experience Platform gain-developer-access

Avant de pouvoir générer des valeurs d’authentification pour l’API Reactor, vous devez disposer d’un accès développeur à Experience Platform. Pour obtenir l’accès développeur, suivez les étapes mentionnées au début du tutoriel sur l’authentification dans Experience Platform. Une fois que vous avez terminé la Obtenir un accès utilisateur Revenez à ce tutoriel pour générer les informations d’identification spécifiques à l’API Reactor.

Génération des informations d’identification d’accès generate-access-credentials

À l’aide d’Adobe Developer Console, vous devez générer les trois informations d’identification d’accès suivantes :

  • {ORG_ID}
  • {API_KEY}
  • {ACCESS_TOKEN}

ID de votre organisation ({ORG_ID}) et clé API ({API_KEY}) peut être réutilisé dans les appels API futurs après leur génération initiale. Cependant, votre jeton d’accès ({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 une API dans l’écran Aperçu du projet.

L’écran Ajouter une API s’affiche. Sélectionner API EXPERIENCE PLATFORM LAUNCH dans la liste des API disponibles 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 Experience Platform.

IMPORTANT
Sélectionnez la variable OAuth serveur à serveur , car il s’agira de la seule méthode prise en charge à l’avenir. La variable Compte de service (JWT) est obsolète. Bien que les intégrations utilisant la méthode d’authentification JWT continueront à fonctionner jusqu’au 1er janvier 2025, Adobe recommande vivement de migrer les intégrations existantes vers la nouvelle méthode OAuth Server-to-Server avant cette date. Pour plus d’informations, consultez la section+----------------+ | badge negative | +================+ | Obsolète | +----------------+Génération d’un jeton Web JSON (JWT) dans le tutoriel sur l’authentification de l’API Platform.

Sélectionnez Suivant pour continuer.

Sélectionnez la méthode d’authentification OAuth serveur à serveur.

L’écran suivant vous invite à sélectionner un ou plusieurs profils de produit à associer à l’intégration de l’API.

NOTE
Les profils de produit sont gérés par votre organisation via Adobe Admin Console et contiennent des jeux d’autorisations spécifiques pour les fonctionnalités granulaires. Les profils de produit et leurs autorisations ne peuvent être gérés que par des utilisateurs disposant de droits d’administrateur au sein de votre entreprise. Si vous ne savez pas quels profils de produit sélectionner pour l’API, contactez votre administrateur.

Sélectionnez les profils de produit souhaités dans la liste, puis sélectionnez Enregistrer l’API configurée pour terminer l’enregistrement de l’API.

Collectez les informations d’identification de . gather-credentials

Une fois l’API ajoutée au projet, la variable API EXPERIENCE PLATFORM La page du projet affiche les informations d’identification suivantes, requises dans tous les appels aux API Experience Platform :

  • {API_KEY} (Identifiant client)
  • {ORG_ID} (ID d’organisation)

Informations sur l’intégration après l’ajout d’une API dans Developer Console.

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

L’étape suivante consiste à générer une {ACCESS_TOKEN} informations d’identification à 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 de Platform.

TIP
Ces jetons expirent après 24 heures. Si vous utilisez cette intégration pour une application, il est préférable d’obtenir votre jeton du porteur par programmation à partir de votre application.

Selon votre cas d’utilisation, vous disposez de deux options pour générer vos jetons d’accès :

Génération manuelle des jetons d’accès manual

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.

Enregistrement d’écran de la génération du jeton d’accès et dans l’interface utilisateur de Developer Console.

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

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.

Tester les informations d’identification de l’API test-api-credentials

En suivant les étapes de ce tutoriel, vous devez disposer de valeurs valides pour {ORG_ID}, {API_KEY}, et {ACCESS_TOKEN}. Vous pouvez désormais tester ces valeurs en les utilisant dans une simple requête cURL à l’API Reactor.

Commencez par lancer un appel API pour répertorier toutes les entreprises.

NOTE
Il se peut que votre organisation ne contienne aucune société. Dans ce cas, la réponse sera un statut HTTP 404 (Not Found). Tant que vous n’obtenez pas d’erreur 403 (Forbidden), vos informations d’identification d’accès sont valides et fonctionnent.

Une fois que vous avez confirmé que vos informations d’identification d’accès fonctionnent, continuez à explorer le reste de la documentation de référence de l’API pour découvrir ses nombreuses fonctionnalités.

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 à lancer des appels à l’API Reactor. Sélectionnez l’un des guides de point d’entrée pour commencer :

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743