Configuration de Developer Console et de Postman
Dans cette leçon, vous allez configurer un projet dans Adobe Developer Console et télécharger des collections de Postman afin de commencer à utiliser les API Platform.
Pour effectuer les exercices d’API de 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 d’API et Adobe Experience Platform fournit des dizaines de collections Postman pour vous aider à exécuter des appels d’API et à découvrir comment ils fonctionnent. Le reste de ce tutoriel suppose une connaissance pratique de Postman. Pour obtenir de l’aide, consultez la documentation de Postman.
Platform est d’abord créée via l’API. Bien que des options d’interface existent également pour toutes les tâches principales, vous souhaiterez peut-être utiliser l’API Platform à un moment donné. Par exemple, pour ingérer des données, déplacer des éléments entre des sandbox, automatiser des tâches de routine ou utiliser de nouvelles fonctionnalités de Platform avant que l’interface utilisateur n’ait été créée.
Architectes de données et 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 allez configurer tous les contrôles d’accès requis pour suivre cette leçon.
Configuration de Adobe Developer Console
Adobe Developer Console est la destination des développeurs pour accéder aux API et aux SDK d’Adobe, écouter des événements en temps quasi réel, exécuter des fonctions sur Runtime ou créer des modules externes pour les applications App Builder. Vous l’utiliserez pour accéder à l’API Experience Platform. Pour plus d’informations, consultez la documentation de Adobe Developer Console
-
Créez un dossier sur votre ordinateur local nommé
Luma Tutorial Assetspour les fichiers utilisés dans le tutoriel. -
Ouvrir le Adobe Developer Console
-
Connectez-vous et vérifiez que vous vous trouvez dans la bonne organisation
-
Sélectionnez Créer un projet dans le menu Démarrage rapide.
-
Dans le projet nouvellement créé, sélectionnez 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 entreprise suivent ce tutoriel) -
Sélectionnez Enregistrer
-
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 puis Suivant.
-
Sélectionnez OAuth serveur à serveur comme informations d’identification et sélectionnez Suivant.
-
Sélectionnez le profil de produit
AEP-Default-All-Userset sélectionnez Enregistrer l’API configurée
-
Votre projet Developer Console est maintenant créé.
-
Dans la section Essayer de la page, sélectionnez Télécharger pour Postman puis sélectionnez OAuth de serveur à serveur pour télécharger le fichier json de l’environnement Postman. Enregistrez le
oauth_server_to_server.postman_environment.jsondans votre dossierLuma Tutorial Assets.
Demandez à un administrateur système d’ajouter les informations d’identification d’API au rôle
Pour utiliser les informations d’identification d’API afin d’interagir avec Experience Platform, vous devez demander à un administrateur système d’affecter les informations d’identification d’API au rôle créé dans la leçon précédente. Si vous n’êtes pas administrateur système, envoyez-le :
-
Le Nom de vos informations d’identification API (
Credential in Luma Tutorial API Project) -
L’e-mail compte technique de vos informations d’identification (cela aidera l’administrateur système à trouver les informations d’identification)
Voici les instructions destinées à l’administrateur système :
-
Se connecter à Adobe Experience Platform
-
Sélectionnez Autorisations dans le volet de navigation de gauche pour accéder à l’écran Rôles
-
Ouvrir 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 du
Credential in Luma Tutorial API Project, en filtrant avec l’adresse électronique du compte technique fournie par le participant au tutoriel, si la liste est longue -
Sélectionner les informations d’identification
-
Sélectionnez Enregistrer
Configuration de Postman
-
Télécharger et installer Postman
-
Ouvrir Postman et créer 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 :
Ajouter le nom du sandbox et l’ID de client
Les variables SANDBOX_NAME, TENANT_ID et CONTAINER_ID ne sont pas incluses dans l’exportation Adobe Developer Console. Nous les ajoutons donc manuellement :
-
Dans Postman, ouvrez le 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 sandbox dans la leçon précédente. Si vous avez utilisé un autre nom pour votre sandbox, par exemple luma-tutorial-ignatiusurilly, veillez à utiliser cette valeur. -
Dans le champ Ajouter une nouvelle variable, saisissez
TENANT_ID -
Accédez à votre navigateur web et recherchez l’ID client de votre société en accédant à l’interface d’Experience Platform et en extrayant la partie de l’URL après le signe @. Par exemple, mon identifiant client est
techmarketingdemos, mais le vôtre est différent :
-
Copiez cette valeur et revenez à l’écran Postman Gérer les environnements .
-
Collez votre ID client dans les deux champs de valeur
-
Dans le champ Ajouter une nouvelle variable, saisissez
CONTAINER_ID -
Saisir des
globaldans les deux champs de valeurnote note NOTE CONTAINER_IDest un champ dont la valeur est modifiée plusieurs fois au cours du tutoriel. Lorsqueglobalest utilisé, l’API interagit avec les éléments fournis par Adobe dans votre compte Platform. Lorsquetenantest utilisé, l’API interagit avec vos propres éléments personnalisés. -
Sélectionnez Enregistrer
Effectuer des appels API
Récupération d’un jeton d’accès
Adobe fournit un ensemble riche de collections de Postman pour vous aider à explorer l’API Experience Platform. Ces collections se trouvent dans le référentiel GitHub d’exemples de Postman Adobe Experience Platform. Vous devez ajouter un signet à ce référentiel, car vous l’utiliserez à de nombreuses reprises tout au long de ce tutoriel et ultérieurement, lorsque vous implémenterez Experience Platform pour votre propre société.
La première collection fonctionne avec les API du service Adobe Identity Management (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 API du service Identity Management dans votre dossier
Luma Tutorial Assets -
Importer la collection dans Postman
-
Sélectionnez la requête oAuth : demande de jeton d’accès puis sélectionnez Envoyer
-
Vous devriez obtenir une réponse
200 OKavec 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
Effectuons maintenant un appel API Platform pour confirmer que nous avons tout configuré correctement.
Ouvrez les collections Experience Platform Postman dans GitHub. Il existe de nombreuses collections sur cette page, pour diverses API Platform. Je vous recommande vivement de le marquer d'un signet.
Maintenant, effectuons notre premier appel API :
- Téléchargez la collection d’API Schema Registry dans votre dossier
Luma Tutorial Assets - L’importer dans Postman
- Ouvrez API Schema Registry > Schémas > Liste des schémas
- Examinez les onglets Params et En-têtes et notez qu’ils incluent certaines des variables d’environnement que nous avons saisies précédemment.
- Notez que le champ En-têtes > Accepter la valeur 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 Envoyer pour effectuer votre premier appel API Platform.
Nous espérons que vous avez reçu une réponse 200 OK réussie contenant une liste des schémas XDM fournis par Adobe disponibles dans votre sandbox, comme illustré ci-dessous.
Si votre appel n’a pas réussi, prenez un moment 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é(e), veuillez demander de l’aide dans le Forum de la communauté ou utilisez le lien situé sur le côté droit de cette page pour « Signaler un problème ».
Avec vos autorisations Platform, votre sandbox et votre configuration de Postman, vous êtes prêt à modéliser des données dans des schémas !