Présentation de la documentation Experience Platform
La documentation de Adobe Experience Platform est disponible pour plusieurs fonctionnalités et services de Platform. Pour accéder à la documentation de l’Experience Platform, revenez à la page d’entrée de la documentation et sélectionnez le guide que vous souhaitez afficher.
Types de documentation des Experience Platform
La documentation de l’Experience Platform est fournie dans plusieurs formats, notamment des vues d’ensemble, des tutoriels et des guides de l’interface utilisateur et de l’API. Les types de documentation les plus courants sont résumés dans la liste suivante :
-
Référence d’API : consultez la documentation de référence d’API de chaque service pour en savoir plus sur les points d’entrée disponibles, y compris les en-têtes, les paramètres, les exemples de requêtes et les réponses. Ces documents de référence n’offrent pas le même niveau de détail que la documentation. Il est recommandé de consulter le guide de développement spécifique au service pour obtenir des exemples détaillés d’utilisation de l’API.
-
Guide de développement : chaque guide de développement fournit des informations détaillées sur l’utilisation de tous les points d’entrée d’API disponibles pour un service spécifique. Le guide comprend les paramètres de requête disponibles, des exemples de requêtes et des exemples de réponses, ainsi que la description des "pièges" à éviter lors d’appels à Platform API.
-
Présentation Platform : une présentation donne un aperçu général du service, ou de la fonctionnalité, et de sa façon d’interagir avec d’autres services La présentation est le meilleur point de départ pour découvrir les nouvelles caractéristiques et fonctionnalités de Platform.
-
Guide de dépannage : consultez le guide de dépannage pour trouver des réponses aux questions fréquentes et des informations sur les messages d’erreur que vous risquez de rencontrer lors de l’utilisation de l’API. Le Experience Platform le guide de dépannage prend en charge les questions générales et les erreurs, tandis que les services individuels fournissent des guides de dépannage spécifiques à leur domaine.
-
Tutoriel : un tutoriel est un guide détaillé de l’interface utilisateur, ou de l’API, ou un mélange des deux, qui permet d’obtenir un résultat spécifique. Contrairement à un guide de développement, un tutoriel d’API ne porte que sur un ou deux points d’entrée et n’est pas une ressource d’API exhaustive. De même, les tutoriels de l’interface utilisateur ne portent que sur des étapes spécifiques et non sur l’interface utilisateur complète disponible pour ce service. Les tutoriels font souvent partie d’un workflow plus large et présentent, dans des « étapes suivantes », d’autres tutoriels que vous pourriez souhaiter tester.
-
Guide de l’interface utilisateur : Un guide de l’interface utilisateur décrit les actions disponibles dans Platform l’interface utilisateur d’un service spécifique. Ces documents contiennent des captures d’écran et des étapes axées sur l’interaction avec Platform via l’interface utilisateur. Tout comme un guide de développement, le guide de l’interface utilisateur décrit toutes les actions et options disponibles, y compris les "pièges" à éviter. Il s’agit de la ressource d’utilisation de l’interface utilisateur la plus détaillée.