Ce guide présente les API Adobe Customer Journey Analytics (CJA), en détaillant l’extraction de données, les solutions personnalisées et l’intégration avec des applications tierces. Il inclut la configuration de l’accès, les clés API, des tests avec Postman, un exemple d’appel API étape par étape ainsi que 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 d’inquiétude ! Ce guide destiné aux débutantes et débutants vous accompagne dans l’essentiel, clarifie le jargon et vous aide à faire vos premiers pas dans l’univers passionnant des API CJA.

Imaginez pouvoir accéder à vos données CJA et les analyser de façon automatisée, sans effort manuel. C’est précisément ce que permettent les API CJA !

Considérez les API comme des messagères : elles transmettent vos requêtes aux serveurs Adobe et vous rapportent les résultats dans un format structuré.

Préparer la réussite

Avant d’effectuer votre premier appel API, il est nécessaire de configurer correctement les accès et les autorisations. Commencez par vérifier que vous êtes ajouté en tant que développeur pour votre organisation. Ensuite, assurez-vous d’avoir accès aux profils de produit avec les autorisations requises.

Étape 1 : obtenir votre clé API
  1. Connectez-vous à Adobe Developer Console.
  2. Créer un nouveau projet puis ajoutez l’API Customer Journey Analytics à votre projet et sélectionnez les profils de produit nécessaires.
  3. Cliquez sur Ajouter au projet et ajoutez également l’API Adobe Experience Platform au projet
  4. Une fois la configuration terminée, toutes les informations nécessaires seront disponibles dans l’onglet Identifiants situé à gauche.

Voici les trois paramètres d’en-tête essentiels requis pour toutes les requêtes API

Veillez à enregistrer ces informations d’identification : elles sont essentielles pour accéder à toute la puissance de l’API. Des instructions détaillées étape par étape sont disponibles dans la section Prise en main de l’API CJA.

Étape 2 : tester la configuration

Une excellente manière de tester les API sans écrire de code consiste à utiliser l’outil puissant et convivial Postman. Après avoir lancé l’application, il est facile d’importer vos identifiants API et de commencer à expérimenter avec des requêtes GET simples pour vérifier que la connexion et l’authentification fonctionnent correctement. Il est recommandé de débuter les tests API par des requêtes GET, car elles sont considérées comme plus sûres et non destructives : elles se contentent de récupérer des données sur le serveur sans effectuer de modifications. À l’inverse, d’autres méthodes HTTP comme les requêtes POST, PUT ou DELETE peuvent modifier ou supprimer des données sur le serveur et doivent donc être testées avec davantage de précaution.

Effectuer votre premier appel API

Commençons par une opération simple : récupérer 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 : Bearer {AUTHORIZATION_TOKEN}

Requête CURL :

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 "Autorisation : Bearer {AUTHORIZATION_TOKEN}"

Vous pouvez également tester ces requêtes dans la documentation du point d’entrée de l’API CJA grâce à la fonctionnalité Essayer. Voici le lien pour tester la requête ci-dessus.

Il suffit de cliquer sur le CTA Essayer, de saisir tous les paramètres obligatoires, dans ce cas les paramètres d’en-tête dont nous avons parlé, puis d’appuyer sur Envoyer.

Vous pouvez également ajouter des paramètres supplémentaires pour personnaliser votre demande. Une liste des paramètres disponibles se trouve dans la section Paramètres de requête de chaque demande API dans la documentation CJA API.

Voici les principaux codes d’état HTTP que vous rencontrerez lors de l’utilisation des API :

Ces codes d’état permettent aux développeuses et développeurs de comprendre précisément ce qui s’est passé lors d’une demande API, ce qui facilite la résolution des problèmes.

NOTE
Lorsque vous utilisez la fonctionnalité Essayer, vérifiez que le jeton d’accès dans le champ Authorization commence par « Bearer ». Si ce préfixe est omis ou mal orthographié, une erreur 401 se produira.

Conseils pour les utilisatrices et utilisateurs débutant·e·s avec les API

  1. Vérifier votre accès : Assurez-vous de disposer des niveaux de permissions adéquats et d’être ajouté·e aux bons profils de produits. L’absence d’un accès approprié est la cause la plus fréquente des demandes API infructueuses
  2. Testez, testez, testez : Utilisez la fonctionnalité Try It dans la documentation de l’API ou Postman pour expérimenter des demandes avant de rédiger du code.
  3. Commencez petit : Démarrez avec des requêtes GET simples et progressez vers des requêtes POST.
  4. Utiliser la Documentation : La Documentation API CJA d’Adobe est votre alliée. Consultez-la régulièrement pour les mises à jour, car les anciennes configurations peuvent ne plus fonctionner comme prévu après une évolution majeure.
  5. Posez vos questions : N’hésitez pas à solliciter la Experience League Adobe Analytics Community pour obtenir de l’aide.

Commencer avec les API CJA d’Adobe peut sembler intimidant au début, mais avec un peu de pratique, vous allez automatiser vos workflows et découvrir des insights en un rien de temps. Alors, lancez-vous : connectez-vous, récupérez vos identifiants et testez un appel API simple. L’aventure API commence ici !

style
article-content-section
5 minutes
style
article-header-section