Présentation des fonctionnalités de l’API Catalog Microsoft Learn

La Microsoft Learn Catalog API est une API Web basée sur REST qui vous permet d'envoyer une requête basée sur le Web à Microsoft Learn et de récupérer des détails sur le contenu de formation et les examens de certification disponibles, tels que les titres, les produits couverts, les niveaux, les liens vers les formations et d’autres métadonnées, et retourne une réponse encodée JSON avec les informations.

Il renvoie des informations sur tous les éléments disponibles publiquement :

  • Modules
  • Unités
  • Parcours d’apprentissage
  • Compétences appliquées
  • Certifications
  • Examens
  • Cours animés par un instructeur

Remarque

Dans le cadre de la mise à jour récente du site Microsoft Learn, un nouveau point de terminaison d’API Catalog est disponible sur le domaine learn.microsoft.com. L’ancien point de terminaison fonctionnera toujours comme prévu. Toutefois, l’avantage de basculer vers le nouveau point de terminaison est qu’il vous donnera des fonctionnalités améliorées telles que des paramètres de requête supplémentaires.

Cas d'utilisation

  • Afficher les métadonnées relatives aux offres de formation et/ou de certification Microsoft Learn
  • Extraire une liste des offres de formation et/ou de certification Microsoft Learn afin de les lier à partir de votre propre expérience en ligne

Fonctionnement de l’API Learn Catalog

Il s’agit d’une API web REST qui retourne une réponse encodée au format JSON. Pour demander le catalogue complet, envoyez une demande GET à :

https://learn.microsoft.com/api/catalog/

La sortie doit ressembler à la capture d’écran ci-dessous. En novembre 2022, la réponse complète est d’environ 13 Mo.

Screenshot of the Learn Catalog API output in Visual Studio Code.

Chaque élément du catalogue d’apprentissage est un objet, avec un ensemble des métadonnées disponibles pour chacun d’eux. Le dictionnaire de données complet et d’autres options sont répertoriés dans la documentation développeur sur l’API Catalog Microsoft Learn. Nous avons également des notes de publication (lien) pour voir quelles sont les dernières mises à jour, ainsi que des informations sur les meilleures pratiques.

Si vous êtes intéressé par son utilisation, consultez l’article sur la prise en main de l’API Catalog Microsoft Learn à l’aide de cURL et de Visual Studio Code.

Configuration requise

Aucune authentification n’est requise pour accéder à l’API Catalog Microsoft Learn. Les utilisateurs peuvent utiliser leur méthode de demande d’API préférée, telle que cURL, Postman, etc.

Exemples

Voici quelques-unes des nombreuses façons dont les utilisateurs se servent de l’API Catalog Learn :

  • Viva Learning a utilisé l’API Catalog Learn pour proposer le catalogue Microsoft Learn dans le cadre de son expérience de base.
  • Les organisations et les établissements d’enseignement utilisent l’API Catalog Learn pour extraire des informations de catalogue et les publier dans leurs systèmes internes de gestion de l’apprentissage (LMS), afin que leurs employés et étudiants puissent y accéder facilement.
  • Les fournisseurs d’apprentissage utilisent l’API Catalog Learn pour extraire des informations de catalogue et les publier dans leurs expériences d’apprentissage client.

Disponibilité et tarification

L’API Catalog Microsoft Learn est disponible publiquement et proposée selon les conditions d’utilisation des API Microsoft. L’utilisation de l’API est gratuite.

Limites

  • L’API contient des modules, des unités, des parcours d’apprentissage, des formations dispensées par un instructeur, des examens et des certifications accessibles au public. Elle ne permet pas de générer de la documentation, des exemples de code, des émissions ou des événements pour l’instant.
  • L’API s’actualise au moins une fois par jour.
  • Les mises à jour apportées à la version de l’API sont communiquées via des mises à jour des notes de publication de l’API Catalog Learn.

Étapes suivantes

Pour en savoir plus sur l’API Catalog Learn, consultez les articles suivants :