Comment formater une requête API ?
Les formats de requête varient selon l’API Experience Platform utilisée. Le meilleur moyen d’apprendre à structurer vos appels API est de suivre les exemples fournis dans la documentation du service Experience Platform que vous utilisez.
Pour plus d’informations sur le formatage des requêtes API, consultez la section du guide de prise en main de l’API Experience Platform consultez des exemples d’appels API.
Quelle est mon organisation ?
Une organisation est une représentation de clientèle pour Adobe. Toutes les solutions Adobe sous licence sont intégrées à cette organisation cliente. Lorsqu’une organisation est autorisée à utiliser Experience Platform, elle peut attribuer un accès aux développeurs et développeuses. L’identifiant d’organisation (x-gw-ims-org-id) représente l’organisation pour laquelle un appel API devrait être exécuté. Il est donc nécessaire de le placer en tant qu’en-tête de toutes les requêtes API. Cet ID est accessible via Adobe Developer Console : dans l’onglet Intégrations, accédez à la section Vue d’ensemble pour toute intégration spécifique afin de trouver l’ID sous Informations d’identification client. Pour une présentation détaillée de la procédure d’authentification dans Experience Platform, consultez le tutoriel sur l’authentification.
Où trouver ma clé API ?
Une clé API doit constituer l’en-tête de toutes les requêtes API. Il est accessible via Adobe Developer Console. Dans la console, sous l’onglet Intégrations, accédez à la section Présentation pour une intégration spécifique et vous trouverez la clé sous Informations d’identification client. Pour une présentation détaillée de la procédure d’authentification dans Experience Platform, consultez le tutoriel sur l’authentification.
Comment obtenir un jeton d’accès ?
Les jetons d’accès doivent être renseignés dans l’en-tête d’autorisation de tous les appels API. Ils peuvent être générés à l’aide d’une commande CURL, à condition que vous ayez accès à une intégration pour une organisation. Les jetons d’accès ne sont valides que pendant 24 heures. Après ce délai, un nouveau jeton doit être généré pour continuer à utiliser l’API. Pour plus d’informations sur la génération des jetons d’accès, consultez le tutoriel sur l’authentification.
Comment utiliser les paramètres de requête ?
Certains points d’entrée de l’API Experience Platform acceptent des paramètres de requête visant à localiser des informations spécifiques et filtrer les résultats renvoyés dans la réponse. Les paramètres de requête sont ajoutés aux chemins de requête avec un point d’interrogation (?), suivi d’un ou plusieurs paramètres de requête sous le format paramName=paramValue. Lorsque vous combinez plusieurs paramètres dans un seul appel, vous devez utiliser une esperluette (&) pour les séparer. L’exemple suivant illustre la manière dont une requête qui utilise plusieurs paramètres de requête est représentée dans la documentation.
Voici quelques exemples de paramètres de requête fréquemment utilisés :
GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created
Pour savoir précisément quels paramètres de requête sont disponibles pour un service ou un point d’entrée en particulier, consultez la documentation spécifique au service.
Comment indiquer un champ JSON à mettre à jour dans une requête PATCH ?
De nombreuses opérations PATCH dans les API Experience Platform utilisent des chaînes JSON Pointer pour indiquer les propriétés JSON à mettre à jour. Elles sont généralement incluses dans les payloads des requêtes au format JSON Patch. Pour plus d’informations sur la syntaxe requise pour ces technologies, consultez le guide de base de l’API.
Puis-je utiliser Postman pour appeler les API Experience Platform ?
Postman est un outil utile pour visualiser les appels vers les API RESTful. Le Guide de prise en main de l’API Experience Platform 🔗 contient une vidéo et des instructions pour l’importation de collections Postman. En outre, une liste des collections Postman pour chaque service est fournie.
Quelle est la configuration requise pour Experience Platform ?
Selon que vous utilisez l’interface utilisateur ou l’API, la configuration requise suivante s’applique :
Pour les opérations basées sur l’interface utilisateur :
- Un navigateur web standard et moderne. Bien que la dernière version de Chrome soit recommandée, les versions majeures actuelles et antérieures de Firefox, Internet Explorer, et Safari sont également prises en charge.
- Dès qu’une nouvelle version majeure est disponible, Experience Platform commence à prendre en charge la version la plus récente, tandis que la prise en charge de la troisième version est abandonnée.
- Les cookies et JavaScript doivent être activés pour tous les navigateurs.
Pour les interactions entre les développeurs et l’API :
- Un environnement de développement à faire évoluer pour les intégrations de REST, de flux continu et de webhook.