Documentation Experience Platform Configuration de Developer Console et Postman

Configuration de Developer Console et Postman

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Rubriques :
API

Créé pour :

Débutant
Intermédiaire
Développeur

Dans cette leçon, vous allez configurer un projet dans Adobe Developer Console et télécharger Postman collections afin de pouvoir commencer à utiliser les API Platform.

Pour terminer les exercices d’API dans ce tutoriel, téléchargez l’application Postman pour votre système d’exploitation. Bien que cela ne soit pas nécessaire pour utiliser les API Experience Platform, Postman facilite les workflows API et Adobe Experience Platform fournit des dizaines de collections Postman pour vous aider à exécuter des appels API et à découvrir comment ils fonctionnent. Le reste de ce tutoriel suppose des connaissances pratiques de Postman. Pour obtenir de l’aide, reportez-vous à la documentation Postman.

Platform est une API d’abord créée. Bien que des options d’interface existent également pour toutes les tâches principales, vous pouvez utiliser l’API Platform à un moment donné. Par exemple, pour ingérer des données, déplacez des éléments entre des environnements de test, automatisez les tâches de routine ou utilisez de nouvelles fonctionnalités de Platform avant la création de l’interface utilisateur.

Les architectes de données et les ingénieurs de données peuvent avoir besoin d’utiliser l’API Platform en dehors de ce tutoriel.

Autorisations requises

Dans la leçon Configurer les autorisations , vous configurez tous les contrôles d’accès requis pour terminer cette leçon.

Configuration de Adobe Developer Console

Adobe Developer Console est la destination des développeurs pour accéder aux API et SDK d’Adobe, écouter des événements en temps quasi réel, exécuter des fonctions sur Runtime ou créer des modules externes ou des applications App Builder. Vous l’utiliserez pour accéder à l’API Experience Platform. Pour plus d’informations, voir la documentation Adobe Developer Console

Créez un dossier sur votre ordinateur local nommé Luma Tutorial Assets pour les fichiers utilisés dans le tutoriel.
Ouvrez le Adobe Developer Console
Connectez-vous et vérifiez que vous vous trouvez dans l’organisation appropriée.
Sélectionnez Créer un nouveau projet dans le menu Démarrage rapide .
Dans le projet nouvellement créé, cliquez sur le bouton Modifier le projet
Remplacez le titre du projet par Luma Tutorial API Project (ajoutez votre nom à la fin si plusieurs personnes de votre société suivent ce tutoriel).
Sélectionnez Save
Sélectionnez Ajouter une API
Filtrez la liste en sélectionnant Adobe Experience Platform
Dans la liste des API disponibles, sélectionnez API Experience Platform et Suivant.
Sélectionnez OAuth Server-to-Server comme informations d’identification et sélectionnez Next.
Sélectionnez le profil de produit AEP-Default-All-Users et sélectionnez Save Configured API
Maintenant, votre projet Developer Console a été créé.
Dans la section Essayez-le de la page, sélectionnez Télécharger pour Postman, puis sélectionnez OAuth Server-to-Server pour télécharger le fichier json d’environnement Postman. Enregistrez le oauth_server_to_server.postman_environment.json dans votre dossier Luma Tutorial Assets.

Demander à un administrateur système d’ajouter les informations d’identification de l’API au rôle

Pour utiliser les informations d’identification de l’API pour interagir avec l’Experience Platform, un administrateur système doit affecter les informations d’identification de l’API au rôle créé dans la leçon précédente. Si vous n’êtes pas administrateur système, envoyez-les :

Nom de vos informations d’identification API (Credential in Luma Tutorial API Project)
L’ e-mail du compte technique de vos informations d’identification (l’administrateur système peut ainsi trouver les informations d’identification)

Voici les instructions pour l’administrateur système :

Connectez-vous à Adobe Experience Platform
Sélectionnez Autorisations dans le volet de navigation de gauche qui vous mènera à l’écran Rôles
Ouvrez le rôle Luma Tutorial Platform
Sélectionnez l’onglet Informations d’identification de l’API
Sélectionnez Ajouter des informations d’identification d’API
Recherchez les informations d’identification Credential in Luma Tutorial API Project, en filtrant avec le courrier électronique du compte technique fourni par le participant au tutoriel, si la liste est longue.
Sélection des informations d’identification
Sélectionnez Save

Configuration de Postman

CAUTION

L’interface de Postman est régulièrement mise à jour. Les captures d’écran de ce tutoriel ont été effectuées avec Postman v10.15.1 pour Mac, mais les options de l’interface ont peut-être changé.

Télécharger et installer Postman
Ouvrez Postman et créez un espace de travail.
Importez le fichier d’environnement json téléchargé, oauth_server_to_server.postman_environment.json
Dans Postman, sélectionnez votre environnement dans la liste déroulante
Sélectionnez l'icône pour afficher les variables d'environnement :

Ajout du nom de l’environnement de test et de l’identifiant du client

Les variables SANDBOX_NAME et TENANT_ID et CONTAINER_ID ne sont pas incluses dans l’exportation Adobe Developer Console. Nous les ajoutons donc manuellement :

Dans Postman, ouvrez les variables d’environnement
Sélectionnez le lien Modifier à droite du nom de l'environnement.
Dans le champ Ajouter une nouvelle variable, saisissez SANDBOX_NAME
Dans les deux champs de valeur, saisissez luma-tutorial, le nom que nous avons donné à notre environnement de test dans la leçon précédente. Si vous avez utilisé un nom différent pour votre environnement de test, par exemple luma-tutorial-ignatiusjreilly, veillez à utiliser cette valeur.
Dans le champ Ajouter une nouvelle variable, saisissez TENANT_ID
Passez à votre navigateur web et recherchez l’ID de client de votre société en accédant à l’interface de l’Experience Platform et en extrayant la partie de l’URL après le signe @. Par exemple, mon identifiant de tenant est techmarketingdemos, mais le vôtre est différent :
Copiez cette valeur et revenez à l’écran Postman Gérer les environnements
Collez l’identifiant du client dans les deux champs de valeur
Dans le champ Ajouter une nouvelle variable, saisissez CONTAINER_ID

Entrez global dans les deux champs de valeur

note note
NOTE
`CONTAINER_ID` est un champ dont la valeur a été modifiée plusieurs fois au cours du tutoriel. Lorsque `global` est utilisé, l’API interagit avec les éléments fournis par l’Adobe dans votre compte Platform. Lorsque `tenant` est utilisé, l’API interagit avec vos propres éléments personnalisés.

Sélectionnez Save

Lancer des appels API

Récupération d’un jeton d’accès

Adobe fournit un riche ensemble de Postman collections pour vous aider à explorer l’API de l’Experience Platform. Ces collections se trouvent dans le référentiel GitHub d’exemples Adobe Experience Platform Postman. Vous devez marquer ce référentiel comme vous l’utiliserez de nombreuses fois tout au long de ce tutoriel et plus tard lorsque vous implémenterez Experience Platform pour votre propre société.

La première collection fonctionne avec les API Adobe Identity Management Service (IMS). Il s’agit d’un moyen pratique de récupérer un jeton d’accès dans Postman.

Pour générer le jeton d’accès :

Téléchargez la collection des API de service Identity Management vers votre dossier Luma Tutorial Assets
Importez la collection dans Postman
Sélectionnez la requête oAuth: Request Access Token et sélectionnez Send
Vous devriez obtenir une réponse 200 OK avec un jeton d’accès dans la réponse.
Le jeton d’accès doit être automatiquement stocké en tant que variable d’environnement ACCESS_TOKEN de votre environnement Postman.

Interaction avec une API Platform

Maintenant, lançons un appel API Platform pour confirmer que nous avons tout correctement configuré.

Ouvrez les collections Experience Platform Postman dans GitHub. Cette page contient de nombreuses collections, pour diverses API Platform. Je recommande vivement de le mettre en signet.

Faisons maintenant notre premier appel API :

Téléchargez la collection d’API Schema Registry dans votre dossier Luma Tutorial Assets.
Importer dans Postman
Ouvrez API Schema Registry > Schémas > Schémas de liste
Examinez les onglets Params et Headers et notez comment ils incluent certaines des variables d’environnement que nous avons saisies précédemment.
Notez que le champ En-têtes > Valeur d’acceptation est défini sur application/vnd.adobe.xed-id+json. Les API Schema Registry nécessitent l’une de ces valeurs d’en-tête Accept spécifiées qui fournissent différents formats dans la réponse.
Sélectionnez Send pour effectuer votre premier appel API Platform !

Espérons que vous obteniez une réponse 200 OK réussie contenant une liste des schémas XDM fournis par l’Adobe dans votre environnement de test, comme illustré ci-dessous.

Premier appel API dans Postman

Si votre appel n’a pas réussi, prenez quelques instants pour déboguer à l’aide des détails de réponse d’erreur de l’appel API et passez en revue les étapes ci-dessus. Si vous êtes bloqué, demandez de l’aide sur le forum de la communauté ou utilisez le lien situé à droite de cette page pour "consigner un problème".

Avec vos autorisations Platform, sandbox et Postman configurées, vous êtes prêt à modéliser les données dans les schémas !

recommendation-more-help

513160b6-bf42-4c58-abdd-4f817b1cccad