Visão geral do recurso API do Catálogo do Microsoft Learn
A API do Catálogo do Microsoft Learn é uma API da Web baseada em REST que permite enviar uma consulta baseada na Web para o Microsoft Learn e obter detalhes sobre o conteúdo de treinamento disponível e exames de certificação, como títulos, produtos cobertos, níveis, links para treinamento e outros metadados, e retorna uma resposta codificada em JSON com as informações.
Ela fornece informações sobre tudo o que está publicamente disponível.
- Módulos
- Unidades
- Percursos de Aprendizagem
- Competências Aplicadas
- Certificações
- Exames
- Instructor-Led Cursos
Observação
Como parte da recente atualização do site Microsoft Learn, está disponível um novo endpoint da API de catálogo no domínio learn.microsoft.com. O ponto de extremidade antigo ainda funcionará conforme o esperado, mas os benefícios de mudar para o novo ponto de extremidade são que ele fornecerá recursos aprimorados, como parâmetros de consulta adicionais.
Casos de uso
- Exibir metadados sobre ofertas de treinamento e/ou certificação do Microsoft Learn
- Extraia uma lista das ofertas de treinamento e/ou certificação do Microsoft Learn para vinculá-las a partir de sua própria experiência online
Como funciona a API do Catálogo do Learn
A API é uma API da Web baseada em REST que retorna uma resposta codificada em JSON. Para solicitar o catálogo completo, envie uma solicitação GET para:
https://learn.microsoft.com/api/catalog/
A saída será semelhante à imagem abaixo. Em novembro de 2022, a resposta completa era de aproximadamente 13 MB.
Cada item do catálogo de aprendizagem é um objeto, com um conjunto de metadados disponíveis para cada um. O dicionário de dados completo e outras opções estão listados na documentação do desenvolvedor do Microsoft Learn Catalog API. Também temos notas de versão (link) para consultar as atualizações mais recentes, bem como informações sobre práticas recomendadas .
Se você estiver interessado em usá-lo, confira o artigo Introdução à API do Catálogo do Microsoft Learn usando cURL e Visual Studio Code.
Requerimentos
Não é necessária autenticação para aceder à API do Catálogo do Microsoft Learn. Os usuários podem usar seu método preferido de solicitação de API, como cURL, Postman, etc.
Exemplos
Abaixo estão algumas das muitas maneiras pelas quais vemos os usuários usando a API do Catálogo do Learn:
- Viva Learning usou a API do Catálogo do Learn para oferecer o catálogo do Microsoft Learn como parte de sua experiência principal.
- Organizações e instituições educacionais usam a API do Catálogo do Learn para extrair informações do catálogo e publicá-las em seus sistemas internos de gerenciamento de aprendizagem (LMS), para que seus funcionários e alunos possam acessá-las facilmente.
- Os provedores de aprendizado usam a API do Catálogo do Learn para extrair informações do catálogo e publicá-las em suas experiências de aprendizado do cliente.
Disponibilidade e preços
A API do Catálogo do Microsoft Learn está disponível publicamente e é oferecida sob o termo dos Termos de Uso das APIs da Microsoft . Não há nenhum custo para usar a API.
Limitações
- A API contém módulos, unidades, caminhos de aprendizagem, cursos ministrados por instrutores, exames e certificações disponíveis publicamente. No momento, ele não produz documentação, exemplos de código, shows ou eventos.
- A API atualiza pelo menos uma vez por dia.
- As atualizações da versão da API serão comunicadas por meio de atualizações das Notas de versão da API do Learn Catalog.
Próximos passos
Para saber mais sobre a API do Catálogo do Learn, revise os seguintes artigos: