Ce guide couvre les API Adobe Customer Journey Analytics (CJA), en détaillant l’extraction des données, les solutions personnalisées et l’intégration tierce. Elle comprend la configuration de l’accès, des clés d’API, des tests avec Postman, un exemple d’appel API détaillé et des conseils pour les nouveaux utilisateurs.
Vous découvrez les API et vous vous demandez comment les API Adobe Customer Journey Analytics (CJA) peuvent vous aider ? Pas de panique ! Dans ce guide destiné aux débutants, nous vous guiderons dans les principes fondamentaux, décomposerons les jargons et vous aiderons à faire vos premiers pas dans le monde passionnant des API CJA.
Imaginez avoir la possibilité d’accéder à vos données CJA et de les analyser par programmation, sans effort manuel. C’est exactement ce que les API CJA vous permettent de faire !
- Extraire efficacement les données : rationaliser l’extraction des données avec des appels API.
- Créer des solutions personnalisées : concevez et implémentez des pipelines de création de rapports automatisés adaptés aux besoins spécifiques de l’entreprise.
- Connexion transparente : activez un flux de données fluide entre CJA et les applications tierces grâce à des intégrations robustes.
Considérez les API comme des messagers : elles transportent vos requêtes vers les serveurs d’Adobe et renvoient les résultats dans un package soigné.
Configuration pour réussir
Avant d’effectuer votre premier appel API, vous devez configurer l’accès et les autorisations appropriés. Tout d’abord, assurez-vous que vous êtes ajouté en tant que développeur pour votre organisation. Vérifiez ensuite que vous avez accès aux profils de produit avec les autorisations nécessaires.
Étape 1 : obtenir votre clé API
- Connectez-vous à Adobe Developer Console.
- Créez un projet ajoutez l’API Customer Journey Analytics à votre projet et sélectionnez les profils de produit requis.
- Cliquez sur Ajouter au projet et ajoutez également l’API Adobe Experience Platform au projet
- Une fois la configuration terminée, vous pourrez obtenir toutes les informations requises sous l’onglet Informations d’identification sur la gauche.
Voici les trois paramètres d’en-tête essentiels requis pour toutes les requêtes API
- Jeton d’accès - Cela permet d’assurer que seuls les utilisateurs et utilisatrices autorisés accèdent aux données et peuvent être générés en cliquant sur le CTA Générer un jeton d’accès mis en surbrillance dans la capture d’écran. Il s’agit du paramètre Autorisation dans la requête API
- ID client - Également appelé clé API, il s’agit de x-api-key dans la requête API
- ID d’organisation - Il s’agit de x-gw-ims-org-id dans la requête API
Veillez à enregistrer ces informations d’identification. Ce sont vos clés pour déverrouiller le pouvoir de l’API. Des instructions détaillées étape par étape sont incluses dans la section Prise en main de l’API CJA.
Étape 2 : tester votre configuration
Un excellent moyen de tester les API sans écrire de code est d’utiliser l’outil puissant et convivial Postman. Après avoir lancé l’application, vous pouvez facilement importer vos informations d’identification d’API et commencer à tester de simples requêtes GET pour vérifier que votre connexion et votre authentification fonctionnent correctement. Il est recommandé de démarrer votre parcours de test d’API avec des requêtes GET, car elles sont considérées comme plus sûres et non destructives, car elles récupèrent uniquement des données du serveur sans apporter de modifications. Cette méthode contraste avec d’autres méthodes HTTP telles que les requêtes POST, PUT ou DELETE, qui peuvent modifier ou supprimer des données sur le serveur et doivent donc être testées avec plus de prudence.
Effectuer un premier appel API
Faisons quelque chose de simple : récupérons une liste des vues de données disponibles dans votre compte CJA.
Exemple : Liste des vues de données
Point d’entrée :
GET https://cja.adobe.io/data/dataviews
En-têtes :
X-api-key : {API_KEY}
X-gw-ims-org-id : {IMS_ORG_ID}
Autorisation : {AUTHORIZATION_TOKEN}
CURL Request:
curl -X GET "https://cja.adobe.io/data/dataviewsexpansion=name%2Cowner%2Corganization%2Cdescription"\
-H "x-api-key: {API_KEY}" \
-H "x-gw-ims-org-id: {IMS_ORG_ID}" \
-H "Authorization: Bearer {AUTHORIZATION_TOKEN}"
Vous pouvez également tester ces requêtes dans la documentation sur les points d’entrée de l’API CJA à l’aide de la fonctionnalité Essayer. Voici le lien pour tester la requête ci-dessus.
Il vous suffit de cliquer sur le CTA Essayer et de saisir tous les paramètres obligatoires, dans ce cas les paramètres d’en-tête dont nous avons discuté et de cliquer sur Envoyer.
Vous pouvez également inclure des paramètres supplémentaires pour personnaliser votre requête. Vous trouverez une liste des paramètres disponibles dans la section Paramètres de requête pour chaque requête d’API dans la documentation de l’API CJA.
Voici les principaux codes de réponse HTTP que vous rencontrerez lorsque vous utiliserez les API :
- 200 : succès — Le serveur a traité la demande avec succès et a renvoyé les données
- 404 : introuvable — Le serveur n’a pas pu trouver la ressource demandée
- 500 : erreur interne du serveur — Une erreur s’est produite côté serveur
Ces codes d’état indiquent aux développeurs ce qui s’est passé exactement pendant une requête d’API, ce qui facilite la résolution des problèmes.
Conseils pour les nouveaux utilisateurs d’API
- Vérifier votre accès : assurez-vous que vous disposez des niveaux d’autorisations appropriés et que vous êtes ajouté aux profils de produit corrects. Le fait de ne pas disposer du droit d’accès est la cause la plus courante de l’échec des requêtes API.
- Tester, tester et tester encore : utilisez la fonctionnalité Essayer de la documentation sur les points d’entrée de l’API ou de Postman pour tester les requêtes avant d’écrire du code.
- Démarrer petit : commencez par des requêtes GET simples et travaillez jusqu’à des requêtes POST.
- Documentation d’utilisation : la documentation sur l’API CJA d’Adobe est votre meilleure amie. Recherchez régulièrement des mises à jour, car les anciennes configurations peuvent ne pas fonctionner comme prévu après des mises à jour majeures.
- Poser des questions : n’hésitez pas à contacter la communauté Experience League Adobe Analytics pour obtenir de l’aide.
La prise en main des API Adobe CJA peut paraître intimidante au premier abord, mais avec un peu d’entraînement, vous automatiserez les workflows et découvrirez des informations en un rien de temps. Alors, commencez par vous connecter, saisissez vos informations d’identification et essayez un simple appel API. Votre aventure API vous attend !