Configuration de l’authentification pour Adobe Target API

Dernière mise à jour : 2023-11-14
  • Créé pour :
  • Developer

La variable Adobe Target API d’administration, notamment Recommendations Admin Les API sont sécurisées par authentification pour s’assurer que seuls les utilisateurs autorisés les utilisent pour accéder à Adobe Target. Utilisez la variable Console Adobe Developer pour gérer cette authentification pour tous Adobe Experience Cloud solutions, y compris Adobe Target.

IMPORTANT

Les informations d’identification du compte de service (JWT) décrites dans cet article seront abandonnées au profit des nouvelles informations d’identification OAuth serveur à serveur.

Les informations d’identification du compte de service (JWT) continueront à fonctionner jusqu’au 1er janvier 2025. Vous devez migrer votre application ou intégration pour utiliser les nouvelles informations d’identification OAuth Server-to-Server avant le 1er janvier 2025.

Pour plus d’informations et des instructions détaillées sur la migration de votre intégration, voir Migration des informations d’identification du compte de service (JWT) vers les informations d’identification OAuth serveur à serveur dans le Developer Console la documentation.

Pour plus d’informations sur la configuration de nouvelles informations d’identification OAuth, voir Mise en oeuvre des informations d’identification OAuth Server-to-Server dans le Developer Console la documentation.

Voici les étapes préliminaires requises pour générer les jetons d’authentification JWT hérités nécessaires pour interagir avec succès. Adobe Target API :

  1. Créez un projet (précédemment appelé intégration) dans le Adobe Developer Console.
  2. Exportez les détails du projet vers Postman.
  3. Générez un jeton d’accès au porteur.
  4. Testez le jeton d’accès au porteur.

Conditions requises

Ressource Détails
Postman Pour réussir ces étapes, obtenez la variable application Postman pour votre système d’exploitation. Postman basic est gratuit avec la création de compte. Bien que non requis pour utiliser Adobe Target API en général, Postman facilite les workflows d’API et Adobe Target fournit plusieurs collections Postman pour aider à exécuter ses API et découvrir comment elles fonctionnent. Le reste de ce guide suppose des connaissances opérationnelles de Postman. Pour obtenir de l’aide, voir Documentation Postman.
Références Le reste de ce guide se familiarisera avec les ressources suivantes :

Création d’un projet Adobe I/O

Dans cette section, vous accédez au Adobe Developer Console et créer un projet pour Adobe Target. Pour plus d’informations, reportez-vous au documentation sur les projets.

<!—(1. Générez votre clé privée et votre certificat public, selon les documentation sur l’authentification. // [//]: # (comme décrit dans la section Étape 1 de Comment configurer l’Adobe IO : Authentification - Étape par étape. Une fois l’étape 1 terminée, revenez à ce guide et reprenez l’étape 2 ci-dessous. // Le résultat de cette étape doit être la création d’un private.key et un certificate_pub.crt fichier . Revenez à ce guide une fois que vous avez généré ces deux fichiers.)—>

  1. Dans le Adobe Admin Console, assurez-vous que Adobe le compte utilisateur a reçu les deux Administrateur de produit et Développeur accès de niveau à Target.

  2. Dans le Console Adobe Developer, sélectionnez la variable Organisation Experience Cloud pour laquelle vous souhaitez créer cette intégration. (Notez qu’il est probable que vous n’ayez accès qu’à une seule Organisation Experience Cloud.)

    configure-io-target-create-project2.png

  3. Cliquez sur Créer un projet.

    configure-io-target-create-project3.png

  4. Cliquez sur Ajouter une API pour ajouter une API REST à votre projet afin d’accéder à Adobe services et produits.

    Ajouter une API

  5. Sélectionner Adobe Target comme la propriété Adobe service avec lequel vous souhaitez intégrer. Cliquez sur le bouton Suivant qui s’affiche.

    configure-io-target-createproject5

  6. Sélectionnez une option pour associer des clés publiques et privées à l’intégration du compte de service pour laquelle vous créez Target. Pour cet exemple, sélectionnez Option 1 : générer une paire de clés et cliquez sur Générer une paire de clés.

    configure-io-target-createproject6

  7. Selon les instructions, prenez note du fichier de configuration automatiquement téléchargé (config), qui contient votre clé privée. Cliquez sur Suivant.

    configure-io-target-createproject7

  8. Dans votre système de fichiers, vérifiez l’emplacement de la variable config, qui est le fichier de configuration compressé créé à l’étape précédente. Encore une fois, ceci config contient votre clé privée, dont vous aurez besoin plus tard. L’emplacement exact de votre système de fichiers peut différer de celui illustré ici.

    configure-io-target-createproject8

  9. De retour dans la console Adobe Developer, sélectionnez l’option profil(s) de produit correspondant aux propriétés dans lesquelles vous utilisez Adobe Recommendations. (Si vous n’utilisez pas de propriétés, sélectionnez l’option Espace de travail par défaut .) Cliquez sur Enregistrer l’API configurée.

    configure-io-target-createproject9

  10. Cliquez sur Créer une intégration. Vous devriez recevoir un message temporaire indiquant que votre API a été correctement configurée.

  11. Pour terminer, renommez votre projet en un nom plus significatif que celui d’origine. Project 1. Pour ce faire, accédez au projet à l’aide du chemin de navigation affiché, cliquez sur Modifier le projet pour accéder au Modifier le projet modale et renommez le projet.

    configure-io-target-createproject11

REMARQUE

Dans cet exemple, nous nommons notre projet "Target Intégration." Si vous prévoyez d’utiliser votre projet pour plus que Adobe Target, vous pouvez le nommer en conséquence. Par exemple, vous pouvez choisir de le nommer "API d’Adobe" ou "API d’Experience Cloud", car il peut être utilisé avec d’autres solutions dans Adobe Experience Cloud.

Exportation des détails du projet

Maintenant que vous disposez d’un projet Adobe que vous pouvez utiliser pour accéder à Target, vous devez vous assurer d’envoyer les détails de ce projet avec vos demandes d’API Adobe. Ces détails sont requis pour interagir avec plusieurs API Adobe, dont plusieurs Target API. Par exemple, les détails de l’intégration incluent les informations d’autorisation et d’authentification requises par la variable Target API d’administration. Par conséquent, pour utiliser les API avec Postman, vous devez obtenir ces détails dans Postman.

Il existe de nombreuses façons de spécifier les détails de votre projet dans Postman, mais dans cette section, nous tirons parti de certaines fonctionnalités et collections préconfigurées. Tout d’abord (dans cette section), vous allez exporter les détails de votre intégration dans un environnement Postman. Ensuite (dans la section suivante), vous allez générer un jeton d’accès au porteur pour vous accorder l’accès aux ressources d’Adobe nécessaires.

REMARQUE

Pour obtenir des instructions vidéo applicables à toute solution Experience Cloud, y compris Target, voir Utilisation de Postman avec des API Experience Platform. Les sections suivantes sont pertinentes pour la Target API : 1. Créez et exportez l’API Experience Platform vers Postman 2. Générez un jeton d’accès avec Postman. Ces étapes sont également fournies ci-dessous.

  1. Toujours dans la variable Console Adobe Developer, accédez à pour afficher les Compte de service (JWT) informations d’identification. Utilisez le volet de navigation de gauche ou le Informations d’identification , comme indiqué.

    JWT1

    Dans Informations d’identification, notez que vous pouvez afficher vos Clé(s) publique(s), ID client, ainsi que d’autres informations relatives à votre compte de service.

    JWT1a

  2. Cliquez pour accéder aux informations sur la variable Adobe Target API. Utilisez le volet de navigation de gauche ou le Produits et services connectés , comme indiqué.

    JWT2

  3. Cliquez sur Téléchargement pour Postman > Compte de service (JWT) pour créer un fichier JSON capturant vos informations d’authentification pour un environnement Postman.

    JWT3

    Notez le fichier JSON dans votre système de fichiers.

    JWT3a

  4. Dans Postman, cliquez sur l’icône d’engrenage pour gérer vos environnements, puis cliquez sur Importer pour importer le fichier JSON (environnement).

    JWT4

  5. Sélectionnez votre fichier et cliquez sur Ouvrir.

    JWT5

  6. Dans Postman Gestion des environnements modale, cliquez sur le nom de l’environnement nouvellement importé pour l’inspecter. (Le nom de votre environnement peut être différent de celui illustré ici. Modifiez le nom suivant vos besoins. Il ne doit pas nécessairement correspondre au nom de la variable Adobe project.)

    JWT6

  7. Remarque CLIENT_SECRET et API_KEY (ainsi que d’autres variables) leurs valeurs sont préremplies, issues de votre intégration, comme défini dans la console Adobe Developer. (Le Postman CLIENT_SECRET doit correspondre au CLIENT SECRET Adobe des informations d’identification telles qu’elles s’affichent dans Developer Console ; et API_KEY dans Postman doit également correspondre à CLIENT ID dans Developer Console.) Par contraste, note PRIVATE_KEY, JWT_TOKEN, et ACCESS_TOKEN sont vides. Commençons par fournir la variable PRIVATE_KEY .

    JWT7

  8. À partir de votre système de fichiers, ouvrez votre config et ouvrez le fichier private fichier de clé.

    JWT8

  9. Sélectionnez et copiez l’intégralité du contenu de la private fichier de clé.

    JWT9

  10. Dans Postman, collez votre valeur de clé privée dans la variable VALEUR INITIALE et VALEUR ACTUELLE des champs.

    JWT10

  11. Cliquez sur Mettre à jour et fermez la fenêtre modale Environnements .

Génération du jeton d’accès au porteur

Dans cette section, vous générez votre jeton d’accès au porteur, nécessaire pour authentifier votre interaction avec Adobe Target API. Pour générer votre jeton d’accès porteur, vous devez envoyer les détails de votre intégration (définis dans les sections précédentes) au Adobe Identity Management Service (IMS). Il existe plusieurs façons de procéder, mais dans ce guide, nous profitons d’une collection Postman contenant un appel IMS prédéfini qui rend le processus direct et facile. Une fois la collection importée, vous pouvez la réutiliser si nécessaire afin de générer de nouveaux jetons non seulement pour Adobe Target, mais également d’autres API d’Adobe.

  1. Accédez au Exemples d’appels API Adobe Service.

    token1

  2. Cliquez sur le bouton Collection Postman de génération de jetons d’accès Adobe I/O.

    token2

  3. Obtenez le fichier JSON brut pour cette collection en cliquant sur Brut, puis en copiant le fichier JSON obtenu dans le presse-papiers. (Vous pouvez également enregistrer le fichier JSON brut sous la forme d’un fichier .json.)

    token3

  4. Dans Postman, importez la collection en la collant et en l’envoyant à partir du Presse-papiers. (Vous pouvez également télécharger le fichier .json que vous avez enregistré.) Cliquez sur Continue (Continuer).

    token4

  5. Sélectionnez la variable IMS : JWT Generate + Auth via User Token dans la collection Postman de génération de jetons d’accès Adobe I/O, vérifiez que votre environnement est sélectionné, puis cliquez sur Envoyer pour générer le jeton.

    token5

    REMARQUE

    Ce jeton d’accès au porteur sera valide pendant 24 heures. Envoyez à nouveau la requête chaque fois que vous devez générer un nouveau jeton.

  6. Ouvrez à nouveau le modal Manage Environments (Gérer les environnements), puis sélectionnez votre environnement.

    token6

  7. Notez que ACCESS_TOKEN et JWT_TOKEN sont désormais renseignées.

    token7

Question : Dois-je utiliser la collection Postman de génération de jeton d’accès Adobe I/O pour générer le jeton web JSON (JWT) et le jeton d’accès porteur ?

Réponse : Non. La collection Postman de génération de jeton d’accès Adobe I/O est disponible à titre de commodité pour générer plus facilement le jeton d’accès JWT et support dans Postman. Vous pouvez également utiliser les fonctionnalités de la console Adobe Developer pour générer manuellement le jeton d’accès au porteur.

Tester le jeton d’accès au porteur

Dans cet exercice, vous utiliserez votre nouveau jeton d’accès au porteur en envoyant une requête API qui récupère une liste des activités de votre Target compte . Une réponse réussie indique que votre Adobe Le projet et l’authentification fonctionnent comme prévu afin d’utiliser l’API.

  1. Importez la variable Adobe Target Collecte Postman des API d’administration. Suivez toutes les invites jusqu’à ce que la collection soit importée dans Postman.

    testtoken1

  2. Développez la collection, puis notez le Lister des activités requête.

    testtoken1

  3. Notez que les variables telles que {{access_token}} ne sont pas résolues au départ. Vous pouvez le résoudre de plusieurs manières différentes ; par exemple, vous pouvez définir une nouvelle variable de collection appelée {{access_token}}: dans ce guide, vous allez modifier la requête d’API afin d’exploiter l’environnement Postman que vous utilisiez précédemment. Cela permettra à l’environnement de continuer à servir de consolidation unique et cohérente de toutes les variables communes à toutes les API Adobe.

    testtoken2

  4. Type à remplacer {{access_token}} avec {{ACCESS_TOKEN}}.

    testtoken3

  5. Type à remplacer {{api_key}} avec {{API_KEY}}.

    testtoken4

  6. Type à remplacer {{tenant}} avec {{TENANT_ID}}. Remarque {{TENANT_ID}} n’est pas encore reconnu.

    testtoken4

  7. Ouvrez le modal Manage Environments (Gérer les environnements), puis sélectionnez votre environnement.

    JWT11

  8. Saisissez pour ajouter une nouvelle {{TENANT_ID}} Variable d’environnement. Copiez et collez votre valeur d’identifiant de tenant dans la variable VALEUR INITIALE et VALEUR ACTUELLE des champs de votre nouveau TENANT_ID Variable d’environnement.

    testtoken5

    REMARQUE

    L’identifiant du client est différent de votre Target clientcode. L’ID de tenant existe dans l’URL lorsque vous êtes connecté à Target. Pour obtenir votre ID de tenant, connectez-vous à Adobe Experience Cloud, ouvrez Target, puis cliquez sur la carte Target . Utilisez la valeur de l’identifiant du client comme indiqué dans le sous-domaine de l’URL. Par exemple, si votre URL lors de la connexion à Adobe Target is <https://mycompany.experiencecloud.adobe.com/...> alors votre identifiant de tenant est "mycompany".

  9. Envoyez votre requête, après avoir vérifié que vous avez sélectionné l’environnement approprié. Vous devriez recevoir une réponse contenant votre liste d’activités.

    testtoken6

Maintenant que vous avez vérifié votre authentification par Adobe, vous pouvez l’utiliser pour interagir avec Adobe Target API (ainsi que d’autres API Adobe). Par exemple, vous pouvez Utilisation des API Recommendations pour créer ou gérer des recommandations, ou vous pouvez les utiliser avec l’événement API de diffusion Target.

Sur cette page