Ler em inglês

Compartilhar via


Visão geral do recurso API de Catálogo do Microsoft Learn

A API de 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 dos treinamentos e os exames de certificação disponíveis, como títulos, produtos cobertos, níveis, links para treinamento e outros metadados, retornando uma resposta codificada em JSON com as informações.

Ela retorna informações sobre tudo o que está publicamente disponível:

  • Módulos
  • Unidades
  • Roteiros de aprendizagem
  • Applied Skills
  • Certificações
  • Exames
  • Cursos com instrutor

Observação

Como parte da atualização recente do site do Microsoft Learn, há um novo ponto de extremidade da API de 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 migrar para o novo ponto de extremidade são os recursos aprimorados, como parâmetros de consulta adicionais.

Casos de uso

  • Exibir metadados sobre ofertas de treinamento e/ou certificação do Microsoft Learn
  • Efetue pull de uma lista das ofertas de treinamento e/ou certificação do Microsoft Learn para vinculá-las da sua experiência online

Como funciona a API de Catálogo do Learn

Trata-se de 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. Em novembro de 2022, a resposta completa passou a ser de aproximadamente 13 MB.

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

Cada item de catálogo de aprendizagem é um objeto, com um conjunto de metadados disponíveis para cada um deles. O dicionário de dados completo e as outras opções estão listados na documentação para desenvolvedores da API de Catálogo do Microsoft Learn. Também temos notas sobre a versão (link) para ver quais são as atualizações mais recentes e as informações de melhores práticas.

Se você tiver interesse em usá-lo, confira o artigo Introdução à API de Catálogo do Microsoft Learn usando o cURL e o Visual Studio Code.

Requisitos

Não há nenhuma autenticação necessária para acessar a API de Catálogo do Microsoft Learn. Os usuários podem usar o método de solicitação de API que preferirem, como cURL, Postman etc.

Exemplos

Confira abaixo algumas das várias maneiras pelas quais vemos usuários usando a API de Catálogo do Learn:

  • A Aprendizagem do Viva usou a API de 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 de Catálogo do Learn para efetuar pull de informações do catálogo e postá-las em seus LMS (sistemas de gerenciamento de aprendizagem) internos, para que os funcionários e alunos possam acessá-los facilmente.
  • Os provedores de aprendizagem usam a API de Catálogo do Learn para efetuar pull das informações do catálogo e postá-las nas experiências de aprendizado do cliente.

Disponibilidade e preços

A API de Catálogo do Microsoft Learn está disponível publicamente e é oferecida de acordo com os Termos de Uso das APIs da Microsoft. Não há nenhum custo para usar a API.

Limitações

  • A API contém módulos disponíveis publicamente, unidades, roteiros de aprendizagem, cursos com instrutor, exames e certificações. Ela não gera documentação, exemplos de código, programas ou eventos no momento.
  • A API é atualizada pelo menos uma vez por dia.
  • As atualizações para a versão da API será comunicada por meio de atualizações nas Notas sobre a versão da API de Catálogo do Learn.

Próximas etapas

Para saber mais sobre a API de Catálogo do Learn, leia os seguintes artigos: