Introducción a la API de catálogo de Microsoft Learn
La API de catálogo de Microsoft Learn es una API web basada en REST que permite enviar una consulta basada en web a Microsoft Learn para obtener detalles sobre el contenido de aprendizaje y los exámenes de certificación disponibles, como los títulos, los productos cubiertos, los niveles, vínculos a recursos de aprendizaje y otros metadatos, y devuelve una respuesta con la información codificada en JSON.
Devuelve información sobre todo el contenido disponible públicamente:
- Módulos
- Unidades
- Rutas de aprendizaje
- Aptitudes aplicadas
- Certificaciones
- Exámenes
- Cursos dirigidos por un instructor
Nota:
La reciente actualización del sitio de Microsoft Learn incluye un nuevo punto de conexión de la API de catálogo en el dominio learn.microsoft.com. El punto de conexión anterior seguirá funcionando según lo previsto, pero la ventaja de cambiar al nuevo punto de conexión es que proporciona características mejoradas, como parámetros de consulta adicionales.
Casos de uso
- Ver metadatos sobre las ofertas de aprendizaje o certificación de Microsoft Learn.
- Extraer una lista de las ofertas de aprendizaje y/o certificación de Microsoft Learn para establecer vínculos a ellas desde su propia experiencia en línea.
Cómo funciona la API de catálogo de Learn
Se trata de una API web basada en REST que devuelve una respuesta codificada en JSON. Para solicitar el catálogo completo, envíe una solicitud GET a:
https://learn.microsoft.com/api/catalog/
La salida es similar a la de la pantalla que se muestra a continuación. En noviembre de 2022, la respuesta completa es de unos 13 MB.
Cada elemento del catálogo de aprendizaje es un objeto y hay un conjunto de metadatos disponible para cada uno. El diccionario de datos completo y otras opciones se enumeran en la Documentación de la API de catálogo de Microsoft Learn para desarrolladores. También hay notas de la versión (vínculo) para conocer las últimas actualizaciones y los procedimientos recomendados.
Si está interesado en usarla, consulte el artículo Introducción al uso de la API de catálogo de Microsoft Learn con curl y Visual Studio Code.
Requisitos
No se requiere autenticación para acceder a la API de catálogo de Microsoft Learn. Los usuarios pueden usar el método que prefieran para enviar solicitudes a la API, como curl, Postman, etc.
Ejemplos
A continuación se indican algunas de las muchas formas en las que vemos que los usuarios usan la API de catálogo de Learn:
- Aprendizaje Viva usa la API de catálogo de Learn para ofrecer el catálogo de Microsoft Learn como parte de su experiencia principal.
- Las organizaciones e instituciones educativas usan la API de catálogo de Learn para extraer información del catálogo y publicarla en sus sistemas internos de administración del aprendizaje (LMS), para que sus empleados y alumnos puedan acceder fácilmente a él.
- Los proveedores de aprendizaje usan la API de catálogo de Learn para extraer información del catálogo y publicarla en sus experiencias de aprendizaje del cliente.
Disponibilidad y precios
La API de catálogo de Microsoft Learn está disponible públicamente y se ofrece bajo los Términos de uso de API de Microsoft. El uso de la API no tiene ningún costo.
Limitaciones
- La API contiene módulos, unidades, rutas de aprendizaje, cursos dirigidos por un instructor, exámenes y certificaciones que están disponibles públicamente. Actualmente, no devuelve documentación, ejemplos de código, programas ni eventos.
- La API se actualiza al menos una vez al día.
- Las actualizaciones de la versión de la API se comunican mediante actualizaciones de las Notas de la versión de la API de Catálogo de Microsoft Learn.
Pasos siguientes
Para obtener más información sobre la API de catálogo de Learn, consulte los siguientes artículos: