Configuration de Developer Console et Postman

Dans cette leçon, vous allez configurer un projet dans la console des développeurs d’Adobes et télécharger Postman pour que vous puissiez commencer à utiliser les API de plate-forme.

Pour terminer les exercices d’API de ce tutoriel, téléchargez l'application Postman pour votre système d'exploitation. Bien qu'il 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 à apprendre comment ils fonctionnent. Le reste de ce tutoriel s'appuie sur des connaissances pratiques de Postman. Pour obtenir de l’aide, veuillez vous référer au Documentation de Postman.

La plate-forme est intégrée en premier lieu dans l’API. Bien que des options d’interface existent également pour toutes les tâches principales, vous pouvez utiliser l’API de plate-forme à un moment donné. Par exemple, pour assimiler des données, déplacer des éléments entre des sandbox, automatiser des tâches de routine ou utiliser de nouvelles fonctionnalités de la plate-forme avant la création de l’interface utilisateur.

Data Architects et Ingénieurs de données Vous devrez peut-être utiliser l’API de plate-forme en dehors de ce tutoriel.

Autorisations requises

Dans la boîte de dialogue Configuration des autorisations vous configurez tous les contrôles d'accès requis pour terminer ce cours.

Configuration de la console des développeurs d’Adobes

  1. Création d’un dossier sur votre ordinateur local nommé Luma Tutorial Assets pour les fichiers utilisés dans le tutoriel.

  2. Ouvrez la Adobe Developer Console

  3. Connectez-vous et confirmez que vous êtes dans l’organisation correcte.

  4. Sélectionner Créer un projet dans Démarrage rapide .

    Créer un projet

  5. Dans le projet nouvellement créé, sélectionnez l’option Ajouter au projet puis sélectionnez API

    Configuration de l’API du projet de la console des développeurs d’Adobe

  6. Filtrer la liste en sélectionnant Adobe Experience Platform

  7. Dans la liste des API disponibles, sélectionnez API Experience Platform et sélectionnez Suivant.

    Configuration de l’API du projet de la console des développeurs d’Adobe

  8. Pour l’authentification à partir de systèmes externes tels que Postman, nous avons besoin d'une paire clé publique/clé privée. Pour générer une nouvelle paire de clés, sélectionnez Option 1 et appuyez sur la touche Génération d’une paire de clés bouton

    Configuration de l’API du projet de la console des développeurs d’Adobe

  9. Une fois les clés prêtes, vous pouvez être invité à télécharger les clés sur votre ordinateur local. Enregistrez les clés incluses dans le package config.zip vers le dossier Luma Tutorial Assets. Nous en aurons besoin dans le prochain exercice.

  10. Une fois la clé générée, la clé publique est automatiquement ajoutée à votre projet, comme illustré dans la capture d’écran. Sélectionnez l’option Suivant bouton.

     Afficher après la clé est générée et sélectionnée

  11. Sélectionnez l’option Luma Tutorial Platform profil de produit et sélectionnez Enregistrer l’API configurée bouton

    Sélectionner le profil de produit

  12. Votre projet Developer Console a été créé !

  13. Dans la boîte de dialogue Essayer de la page, sélectionnez Télécharger pour Postman puis sélectionnez Compte de service (JWT) pour télécharger le fichier Postman fichier json d'environnement. Enregistrez la service.postman_environment.json dans votre Luma Tutorial Assets dossier.

    Configuration de l’API du projet de la console des développeurs d’Adobe

    REMARQUE

    Les administrateurs système de votre organisation peuvent voir le projet comme un "identifiant d’API" dans le profil de produit dans le Admin Console

    Configuration de l’API du projet de la console des développeurs d’Adobe

Vous avez peut-être remarqué que le projet s’est vu attribuer un numéro, par exemple "Projet 12" :

  1. Sélectionnez le numéro de projet dans le chemin de navigation.

  2. Sélectionnez l’option Modifier le projet bouton

  3. Modifiez la Titre du projet à Luma Tutorial API Project (si plusieurs personnes de votre entreprise suivent ce tutoriel, ajoutez votre nom à la fin)

  4. Sélectionnez l’option Enregistrer bouton

    Configuration de l’API du projet de la console des développeurs d’Adobe

Configurer Postman

ATTENTION

L'interface de Postman est régulièrement mise à jour. Les captures d'écran de ce tutoriel ont été réalisées avec Postman v9.0.5 pour Mac, mais les options d'interface ont peut-être changé.

  1. Téléchargement et installation Postman

  2. Ouvrir Postman et importer le fichier d’environnement json téléchargé, service.postman_environment.json
    Environnement d’importation

  3. Entrée Postman, sélectionnez votre environnement dans la liste déroulante.

    Modification de l’environnement

  4. Sélectionnez l’option oeil pour afficher les variables d’environnement :

    Configuration de l’API du projet de la console des développeurs d’Adobe

Mettre à jour le nom de l'environnement

Dans la mesure où le nom exporté de l’environnement à partir de Developer Console est généré aléatoirement, donnez-lui un nom plus descriptif afin de ne pas confondre les environnements plus tard lorsque vous commencez à travailler sur votre implémentation de plate-forme réelle :

  1. L’écran des variables d’environnement étant toujours ouvert, sélectionnez Modifier en haut à droite

  2. Mettez à jour la Nom de l’environnement à Luma Tutorial

  3. Quitter Gestion des environnements modale ouvert en mode édition, car nous allons la modifier plus avant à l’étape suivante

    Mettre à jour le nom de l'environnement Postman

Ajout de la clé privée

Il est maintenant temps d'ajouter la valeur PRIVATE_KEY à l'environnement Postman.

  1. Extraire le fichier téléchargé config.zip qui a été généré lors de l’exercice précédent lors de la création du projet de console des développeurs. Ce fichier compressé contient deux fichiers :

    • private.key
    • certificate_pub.crt
  2. Ouvrez la private.key dans un éditeur de texte et copiez le contenu.

  3. Dans Postman, sur le Gestion des environnements > Modifier modale toujours ouverte à partir du dernier exercice, collez les valeurs copiées devant PRIVATE_KEY dans la Valeur initiale et Valeur actuelle colonnes.

  4. Sélectionnez Enregistrer

    Clé privée collée dans Postman

Ajout des JWT et des jetons d’accès

Adobe fournit un ensemble riche de Postman pour vous aider à explorer l’API Experience Platform. Ces collections se trouvent dans le dossier Adobe Experience Platform Postman fait des échantillons de repo GitHub. Vous devez mettre en signet ce repo, car vous l'utiliserez à de nombreuses reprises tout au long de ce tutoriel et plus tard pendant la mise en oeuvre de l'Experience Platform pour votre propre entreprise.

La première collection fonctionne avec les API IMS (Adobe Identity Management Service). C'est un moyen pratique de renseigner JWT_TOKEN et ACCESS_TOKEN depuis Postman. destiné à des cas d'utilisation non liés à la production comme suivre ce tutoriel dans votre sandbox. Vous pouvez également générer le jeton JWT dans la console de développement des Adobes. Cependant, comme elle expire régulièrement, l’utilisation de cette collection vous permet de l’actualiser sans devoir revenir sur la console de développement d’Adobes lors de l’achèvement de ce tutoriel.

AVERTISSEMENT

Comme indiqué dans la section API de service Identity Management Adobe README, les méthodes de génération indiquées conviennent à une utilisation non-productive. La signature locale charge une bibliothèque JavaScript à partir d’un hôte tiers et la signature à distance envoie la clé privée à un service Web détenu et exploité par un Adobe. Bien que l'Adobe ne stocke pas cette clé privée, les clés de production ne doivent jamais être partagées avec quiconque.

Pour générer les jetons :

  1. Téléchargez le fichier Collection de génération de jetons d’accès de la console des développeurs à Luma Tutorial Assets dossier

  2. Importation de la collection dans Postman

  3. Sélectionnez la demande. IMS : JWT Generate + Auth via User Token et sélectionnez Envoyer

    Demande de jetons

  4. Le JWT_TOKEN et ACCESS_TOKEN remplissage automatique dans les variables d’environnement de Postman.

    Postman

Ajouter le nom du sandbox et l'ID du client

Le SANDBOX_NAME et TENANT_ID et CONTAINER_ID ne sont pas incluses dans l’exportation vers la console de développement d’Adobe. Nous les ajoutons donc manuellement :

  1. Entrée Postman, ouvrez le noeud Variables d’environnement

  2. Sélectionnez l’option Modifier lien vers la droite du nom de l’environnement

  3. Dans la boîte de dialogue Ajouter un nouveau champ de variable, entrez SANDBOX_NAME

  4. Dans les deux champs de valeur, entrez luma-tutorial, le nom que nous avons donné à notre sandbox dans la leçon précédente. Si vous avez utilisé un nom différent pour votre sandbox, par exemple luma-tutorial-ignatiusjreilly, veillez à utiliser cette valeur.

  5. Dans la boîte de dialogue Ajouter un nouveau champ de variable, entrez TENANT_ID

  6. Basculez vers votre navigateur web et recherchez l’ID de client de votre entreprise en accédant à l’URL de l’interface d’Experience Platform et en extrayant la partie de l’URL après le signe @. Par exemple, mon ID de client est techmarketingdemos mais le vôtre est différent :

    Obtention de l’ID de client à partir de l’URL de l’interface de plate-forme

  7. Copiez cette valeur et revenez à la Postman Écran Gérer les environnements

  8. Collez votre ID de client dans les deux champs de valeur.

  9. Dans la boîte de dialogue Ajouter un nouveau champ de variable, entrez CONTAINER_ID

  10. Entrée global dans les deux champs de valeur

    REMARQUE

    CONTAINER_ID est un champ dont la valeur change plusieurs fois au cours du tutoriel. Lorsque global est utilisé, l’API interagit avec les éléments fournis par l’Adobe dans votre compte de plate-forme. Lorsque tenant est utilisé, l’API interagit avec vos propres éléments personnalisés.

  11. Sélectionnez Enregistrer

    Champs SANDBOX_NAME, TENANT_ID et CONTAINER_ID ajoutés en tant que variables d’environnement

Effectuer un appel d'API de plate-forme

Nous allons maintenant lancer un appel d’API de plate-forme pour confirmer que nous avons tout configuré correctement.

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

Faisons maintenant notre premier appel d’API :

  1. Téléchargez le fichier Collection d'API Schema Registry à Luma Tutorial Assets dossier
  2. Importer dans Postman
  3. Ouvrir API de registre de schémas > Classes > Récupère une liste de classes dans le conteneur spécifié.
  4. Regardez la Params et En-têtes et notez comment ils incluent certaines des variables d’environnement que nous avons entrées précédemment.
  5. Notez que la En-têtes > Champ de valeur Accepter est défini sur application/vnd.adobe.xed-id+json. Les API de registre de schémas nécessitent l'une de ces valeurs d’en-tête Accepter spécifiées qui fournissent des formats différents dans la réponse.
  6. Sélectionner Envoyer pour effectuer votre premier appel d’API de plate-forme !

J'espère que vous avez réussi 200 OK contenant la liste des classes XDM standard disponibles dans votre sandbox, comme illustré ci-dessous.

Premier appel d’API dans Postman

Si votre appel n’a pas réussi, prenez le temps de déboguer en utilisant les détails de la réponse d’erreur de l’appel d’API et passez en revue les étapes ci-dessus. Si vous êtes bloqué, veuillez demander de l’aide dans le fichier Forum communautaire ou utilisez le lien situé à droite de cette page pour "Enregistrer un problème".

Ressources supplémentaires

Avec vos autorisations de plate-forme, sandbox et Postman , vous êtes prêt à données de modèle dans les schémas!

Sur cette page