Visão geral do recurso de API do Catálogo do Microsoft Learn
A API do Catálogo do Microsoft Learn é uma API 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.
Ele retorna informações sobre todos os dados disponíveis publicamente:
- Módulos
- Unidades
- Roteiros de Aprendizagem
- Habilidades Aplicadas
- Certificações
- Exames
- Cursos Instructor-Led
Nota
Como parte da atualização recente do site do Microsoft Learn, há um novo ponto de extremidade da API do Catálogo disponível no domínio learn.microsoft.com. O ponto de extremidade antigo ainda funcionará conforme o esperado, mas os benefícios de alternar 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
- Puxe uma lista das ofertas de treinamento e/ou certificação do Microsoft Learn para vinculá-las a partir da sua própria plataforma online.
Como funciona a API do Catálogo do Learn
A API é uma API 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 à captura de tela abaixo. A partir de novembro de 2022, a resposta completa é de aproximadamente 13 MB.
Cada item de catálogo de aprendizado é 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 da API do Catálogo do Microsoft Learn. Também temos notas de versão (link) para ver quais são as atualizações mais recentes e obter informações sobre práticas recomendadas.
Se você estiver interessado em usá-la, confira o artigo Comece a usar a API do Catálogo do Microsoft Learn com cURL e Visual Studio Code.
Requisitos
Não há nenhuma autenticação necessária para acessar a API do Catálogo do Microsoft Learn. Os usuários podem usar seu método de solicitação de API preferencial, como cURL, Postman etc.
Exemplos
Abaixo estão algumas das várias maneiras pelas quais vemos usuários usando a API do Catálogo do Learn:
- o 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 de ensino usam a API do Catálogo do Learn para extrair informações do catálogo e postá-los em seus LMS (sistemas internos de gerenciamento de aprendizagem), para que seus funcionários e alunos possam acessá-los facilmente.
- Os provedores de aprendizagem usam a API do Catálogo do Learn para extrair informações do catálogo e postá-los em suas experiências de aprendizagem do cliente.
Disponibilidade e preços
A API do Catálogo do Microsoft Learn está disponível publicamente e é oferecida sob os Termos de Uso das APIs da Microsoft. Não há cobrança para usar a API.
Limitações
- A API contém módulos, unidades, roteiros de aprendizagem, cursos ministrados por instrutores, exames e certificações. Ele não gera documentação, exemplos de código, shows ou eventos no momento.
- A API atualiza pelo menos uma vez por dia.
- As atualizações para a versão da API serão comunicadas por meio de atualizações nas Notas de Lançamento da API do Catálogo do Learn.
Próximas etapas
Para saber mais sobre a API do Catálogo do Learn, examine os seguintes artigos: