Compartilhar via

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 com instrutor

Nota

Um novo conjunto de pontos de extremidade de API para acessar os Dados do Catálogo do Microsoft Learn, que substitui a API do Catálogo do Learn, já está disponível. O ponto de extremidade existente documentado aqui continuará funcionando até meados de 2026, mas está planejado para substituição. Recomendamos migrar para o novo ponto de extremidade para aproveitar os recursos aprimorados, incluindo parâmetros de consulta adicionais. Se você estiver interessado em migrar para os novos endpoints da API do Catálogo, entre em contato com LearnPlatformAPIMigration@microsoft.com.

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.

Captura de tela da saída da API do Catálogo do Learn no Visual Studio Code.

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 de desenvolvedores da API do Catálogo do Microsoft Learn. Também temos notas sobre a versão (link) para ver as atualizações mais recentes e as informações de melhores práticas.

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 conforme 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 das Notas sobre a versão 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:

  • Last updated on