Questions fréquentes sur l’API Catalog Microsoft Learn
Cet article liste les questions fréquentes (FAQ) sur l’API Catalog Microsoft Learn, avec leurs réponses et des liens vers des informations supplémentaires si nécessaire.
Général
Q : Combien coûte l’utilisation de l’API Catalog Learn ?
L’utilisation de l’API Catalog Learn est gratuite. Pour plus d’informations, consultez la section Disponibilité et tarification de l’article de présentation des fonctionnalités de l’API Catalog Learn.
Q : Quelles sont les règles d’utilisation de l’API Catalog Learn ?
Consultez les conditions d’utilisation de Microsoft Learn et de l’API Microsoft.
Q : Dois-je m’inscrire ou obtenir des clés pour utiliser l’API Catalog Learn ?
Non. L’API est disponible publiquement. Consultez la section Prise en main de l’article API Catalog Learn utilisant cURL et Visual Studio Code et/ou l’article Informations de référence sur l’API Catalog Learn destinées aux développeurs.
Q : Cette API permettra-elle à nos utilisateurs de consommer le contenu Learn à l’intérieur de notre plateforme ?
Non. L’API Catalog Learn fournit des métadonnées sur le contenu et des liens directs vers le contenu. Les utilisateurs peuvent intégrer ces liens dans des Learning Management System (Système de gestion de l’apprentissage, LMS) ou une expérience web selon les Conditions d’utilisation d’une API Microsoft.
Q : Les données retournées par l’API Catalog Learn restent-elles statiques ou changent-elles ?
Les données changent chaque fois qu’un nouveau contenu est ajouté, modifié ou supprimé, ce qui a généralement lieu quotidiennement.
Réponse de l’API
Q : Puis-je récupérer toutes les données en même temps ?
Oui. Utilisez le point de terminaison de base learn.microsoft.com/api/catalog pour obtenir la réponse complète. Pour plus d’informations sur les demandes d’API, consultez l’article Informations de référence sur l’API Catalog Learn destinées aux développeurs.
Q : Puis-je pré-filtrer la réponse ?
Oui. Consultez les filtres de requête disponibles dans l’article Informations de référence sur l’API Catalog Learn destinées aux développeurs.
Q : Les UID sont-ils uniques pour chaque objet de contenu ?
Oui. UID signifie « ID unique » et est unique pour chaque objet de contenu. Si un UID change, même si le titre ou d’autres métadonnées restent identiques, le contenu est considéré comme un nouvel objet.
Q : Pourquoi existe-t-il des balises HTML dans le résumé du module ?
Nous essayons généralement de conserver la mise en forme du résumé aussi brut que possible, mais il est parfois nécessaire de mettre en évidence ou de lier certains textes.
Q : Pourquoi n’existe-t-il pas de liens pour les unités individuelles ?
Les unités ne sont pas écrites en tant que contenu autonome. Elles sont destinées à être utilisées dans un ordre spécifique pour le module. Pour cette raison, nous incluons le lien vers la page de détails du module et la première unité afin que les utilisateurs puissent démarrer à cet endroit-là et poursuivre la lecture du contenu.
Q : Comment savoir quel contenu est nouveau ?
La valeur last_modified vous indique la dernière modification de l’enregistrement.
Q :L’authentification unique (SSO) est-elle activée pour les liens de contenu ?
Pas pour l'instant. Notre objectif est d’activer l’authentification unique prochainement.
Contenu
Q : L’UID est-il unique pour le contenu ?
Oui. UID signifie « ID unique » et est unique pour chaque objet de contenu. Si un UID change, même si le titre ou d’autres métadonnées restent identiques, le contenu est considéré comme un nouvel objet.
Q : Tous les modules font-ils partie d’un parcours d’apprentissage ?
Non. Les modules sont tous autonomes, dans le sens où ils enseignent un scénario ou un concept de bout en bout et ne nécessitent pas de suivre des modules prérequis. Certaines se suffisent à elles-mêmes et elles ne font pas partie d’un parcours d’apprentissage. D’autres sont regroupées dans un ou plusieurs parcours d’apprentissage qui présentent à l’utilisateur des concepts plus avancés. Un module ne doit pas nécessairement faire partie d’un parcours d’apprentissage, ou il peut faire partie d’un ou de plusieurs parcours d’apprentissage.
Q : Comment savoir quand du contenu a été ajouté, actualisé ou supprimé ?
Lorsque de nouveaux objets de contenu sont ajoutés, ils apparaissent sous la forme d’un nouvel objet (identifié par UID) dans la réponse. Lorsque du contenu est modifié, vous pouvez le déterminer en vous référant à sa valeur last_modified. Lorsque du contenu est supprimé, l’objet de contenu est supprimé de la réponse. Bien qu’il existe parfois un léger retard sur la mise à jour du contenu dans la réponse d’API quand un utilisateur suit l’URL vers le contenu, il voit toujours les informations les plus récentes. En cas de suppression du contenu, l’ancienne URL redirige vers le nouveau contenu ou la nouvelle expérience, ou vers la meilleure option suivante.
Notamment, le contenu est mis à jour en permanence. Nous publions les mises à jour disponibles deux fois par jour. Elles peuvent être mineures (p. ex. des modifications de texte mineures) ou majeures (p. ex. des révisions, des ajouts ou des suppressions majeurs). En général, le portefeuille de contenu est géré comme un projet open source massif et hautement régi ayant des milliers de contributeurs, et par conséquent, des changements se produisent tout le temps. Si vous utilisez l’API Catalog Learn dans votre système de production, vous devez en être conscient et faire en sorte que votre système soit en mesure de gérer ces changements.
Q : J’ai suivi un lien marqué d’un signet vers du contenu, mais il m’affiche maintenant un contenu autre que celui prévu. Pourquoi ?
Nous faisons tout notre possible pour qu’aucun utilisateur ne se retrouve dans une impasse (404) avec des liens vers notre site. Quand du contenu est modifié ou remplacé, nous implémentons une redirection pour l’ancien lien qui vous permet automatiquement d’accéder au nouveau contenu. Dans le cas d’un contenu déconseillé et non remplacé pour diverses raisons, nous effectuons une redirection vers le contenu le plus approprié qui peut avoir une étendue légèrement modifiée, ou vers une page de destination, etc.
Q : Comment accéder aux catalogues de documentation, de vidéos et d’exemples de code ?
Il n’existe aucun moyen par programme pour l’instant d’accéder à ces catalogues. Notre objectif est d’activer l’accès par programmation à ces catalogues à l’avenir.
Localisation
Q : Quelles langues sont disponibles dans Microsoft Learn ?
Plus de 65 paramètres régionaux sont disponibles dans Microsoft Learn. Vous pouvez voir une liste complète ici via le pied de page du site (sélectionnez la langue que vous affichez pour voir la liste complète).
Q : Le contenu est-il disponible dans d’autres langues ?
Cela dépend. Nous voulons rendre le contenu disponible dans toutes les langues dans lesquelles les produits enseignés dans le contenu sont disponibles. Lorsque des apprenants visitent le site Microsoft Learn dans des paramètres régionaux donnés, si le contenu n’y est pas disponible, l’utilisateur voit l’en-tête et le pied de page dans leurs paramètres régionaux souhaités et la langue par défaut du contenu principal est en anglais jusqu’à ce qu’une version localisée soit disponible.
Q : Le contenu est-il différent pour un objet de contenu donné, selon la langue dans laquelle vous l’affichez ?
C’est une possibilité. Lorsque des mises à jour sont publiées dans le contenu en anglais, nos pipelines de localisation font en sorte que les versions localisées soient mises à jour dès que possible, généralement dans les quelques jours suivant la modification d’origine.
Autre
Q : Existe-t-il des fonctionnalités ou une API de création de rapports pour recevoir des données telles que des affichages, des clics, l’achèvement ?
Nous n’avons pas d’API de création de rapports pour l’instant. Nous disposons d’une fonctionnalité de création de rapports organisationnels qui permet aux organisations de générer des rapports sur les achèvements des utilisateurs.
Étapes suivantes
Vous pouvez en apprendre plus sur l’API Catalog Learn en consultant les liens suivants :