Configuration de l’authentification pour les API Adobe Target

Les API d'administration Adobe Target, y compris les API Recommendations Admin, sont sécurisées par l'authentification pour s'assurer que seuls les utilisateurs autorisés les utilisent pour accéder à Adobe Target. Utilisez Adobe Developer Console pour gérer cette authentification pour tous les 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 la documentation Developer Console.
Pour plus d’informations sur la configuration des nouvelles informations d’identification OAuth, voir Mise en oeuvre des informations d’identification OAuth serveur à serveur dans la documentation Developer Console.

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

  1. Créez un projet (précédemment appelé intégration) dans 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 l’ application Postman pour votre système d’exploitation. Postman basic est gratuit avec la création de compte. Bien que cela ne soit pas nécessaire pour utiliser les API Adobe Target en général, Postman facilite les processus d’API et Adobe Target fournit plusieurs collections Postman pour aider à exécuter ses API et apprendre à les utiliser. Le reste de ce guide suppose des connaissances opérationnelles de Postman. Pour obtenir de l’aide, reportez-vous à la 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 à Adobe Developer Console et créez un projet pour Adobe Target. Pour plus d’informations, consultez la documentation sur les projets.

<!—(1). Générez votre clé privée et votre certificat public, conformément à la documentation sur l'authentification. // [/] : # (comme décrit dans Étape 1 de Configuration de 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 fichier private.key et d’un fichier certificate_pub.crt. Revenez à ce guide une fois que vous avez généré ces deux fichiers.)—>

  1. Dans Adobe Admin Console, assurez-vous que votre compte utilisateur Adobe a reçu à la fois l’accès de niveau Administrateur de produit et Développeur à Target.

  2. Dans le Adobe Developer Console, sélectionnez le Experience Cloud Organization pour lequel vous souhaitez créer cette intégration. (Notez qu’il est probable que vous n’ayez accès qu’à un seul Experience Cloud Organization.)

    configure-io-target-create-project2.png

  3. Cliquez sur  Create new project.

    configure-io-target-create-project3.png

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

    Ajouter une API

  5. Sélectionnez Adobe Target comme service Adobe avec lequel vous souhaitez intégrer. Cliquez sur le bouton Next qui s’affiche.

    configure-io-target-create-project5

  6. Sélectionnez une option pour associer des clés publiques et privées à l’intégration du compte de service que vous créez pour Target. Pour cet exemple, sélectionnez Option 1: Generate a key pair et cliquez sur Generate keypair.

    configure-io-target-create-project6

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

    configure-io-target-create-project7

  8. Dans votre système de fichiers, vérifiez l’emplacement de config, qui est le fichier de configuration compressé créé à l’étape précédente. Encore une fois, ce fichier 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-create-project8

  9. De retour dans Adobe Developer Console, sélectionnez le 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 Workspace par défaut .) Cliquez sur  Save configured API.

    configure-io-target-create-project9

  10. Cliquez sur Create Integration. 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 le Project 1 d’origine. Pour ce faire, accédez au projet à l’aide du chemin de navigation affiché, cliquez sur Edit project pour accéder au modal Edit Project et renommez le projet.

    configure-io-target-createproject11

NOTE
Dans cet exemple, nous nommons notre projet "Target Integration". Si vous prévoyez d’utiliser votre projet pour plus de 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 d’Adobe. Ces détails sont requis pour interagir avec plusieurs API Adobe, y compris plusieurs API Target. Par exemple, les détails de l’intégration incluent les informations d’autorisation et d’authentification requises par les API d’administration Target. 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.

NOTE
Pour obtenir des instructions vidéo applicables à toute solution Experience Cloud, y compris Target, voir Utilisation de Postman avec les API Experience Platform. Les sections suivantes concernent les API Target : 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 le Adobe Developer Console, accédez aux Service Account (JWT) informations d’identification de votre nouveau projet. Utilisez le volet de navigation de gauche ou la section Credentials comme indiqué.

    JWT1

    Dans Credential details, notez que vous pouvez afficher vos Public key(s), Client ID et d'autres informations relatives à votre compte de service.

    JWT1a

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

    JWT2

  3. Cliquez sur Download for Postman > Service Account (JWT) pour créer un fichier JSON qui capture 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 représentant un engrenage pour gérer vos environnements, puis cliquez sur Import pour importer le fichier JSON (environnement).

    JWT4

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

    JWT5

  6. Dans le modal Postman Gérer les environnements , 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 du projet Adobe.)

    JWT6

  7. Remarque : CLIENT_SECRET et API_KEY (avec d’autres variables) ont leurs valeurs préremplies, issues de votre intégration, comme défini dans Adobe Developer Console. (La variable Postman CLIENT_SECRET doit correspondre aux informations d’identification de l’Adobe CLIENT SECRET affichées dans Developer Console, et API_KEY dans Postman doit également correspondre à CLIENT ID dans Developer Console.) En revanche, la note PRIVATE_KEY, JWT_TOKEN et ACCESS_TOKEN sont vides. Commençons par fournir la valeur PRIVATE_KEY.

    JWT7

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

    JWT8

  9. Sélectionnez et copiez tout le contenu du fichier de clé private.

    JWT9

  10. Dans Postman, collez votre valeur de clé privée dans les champs INITIAL VALUE et CURRENT VALUE .

    JWT10

  11. Cliquez sur Update et fermez le modal 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 les API Adobe Target. Pour générer votre jeton d’accès au 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 pour d’autres API d’Adobe.

  1. Accédez aux exemples d’appels de l’API Adobe Identity Management Service.

    token1

  2. Cliquez sur le Adobe I/O Access Token Generation Postman collection.

    token2

  3. Obtenez le fichier JSON brut pour cette collection en cliquant sur Raw, 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.

    token4

  5. Sélectionnez la requête 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é et cliquez sur Send pour générer le jeton.

    token5

    note note
    NOTE
    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 les valeurs 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 Adobe Developer Console 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 compte Target. Une réponse réussie indique que votre projet Adobe et votre authentification fonctionnent comme prévu afin d’utiliser l’API.

  1. Importez la Adobe Target collection 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 et notez la requête List activities.

    testtoken1

  3. Notez que les variables telles que {{access_token}} ne sont initialement pas résolues. Vous pouvez résoudre ce problème de plusieurs manières différentes (par exemple, vous pouvez définir une nouvelle variable de collection appelée {{access_token}}). Cependant, 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}} par {{ACCESS_TOKEN}}.

    testtoken3

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

    testtoken4

  6. Type à remplacer {{tenant}} par {{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 variable d'environnement {{TENANT_ID}}. Copiez et collez la valeur de votre ID de tenant dans les champs INITIAL VALUE et CURRENT VALUE de votre nouvelle variable d'environnement TENANT_ID.

    testtoken5

    note note
    NOTE
    L'identifiant du tenant 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 est <https://mycompany.experiencecloud.adobe.com/...>, votre ID 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 d’Adobe, vous pouvez l’utiliser pour interagir avec les API Adobe Target (ainsi qu’avec d’autres API d’Adobe). Par exemple, vous pouvez utiliser les API Recommendations pour créer ou gérer des recommandations, ou vous pouvez l’utiliser avec l’ API de diffusion Target.

recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3