Perguntas frequentes sobre a API do Catálogo do Microsoft Learn
Este artigo lista as perguntas frequentes sobre a API do Catálogo do Microsoft Learn, com suas respostas e links para mais informações, conforme necessário.
Geral
P: quanto custa usar a API do Catálogo do Learn?
Não há custo para usar a API do Catálogo do Learn. Para obter mais informações, consulte a seção Disponibilidade e Preços do artigo de visão geral do recurso de API do Catálogo do Learn.
P: Quais são as regras para usar a API do Catálogo do Learn?
Consulte os Microsoft Learn e os Termos de Uso da API da Microsoft .
P: Preciso fazer a integração ou obter chaves para usar a API do Catálogo Learn?
Não. A API está disponível publicamente. Confira o artigo de introdução à API do Catálogo do Learn, usando cURL e Visual Studio Code e/ou o artigo de Referência do Desenvolvedor da API do Catálogo do Learn.
P: essa API permitirá que nossos usuários consumam o conteúdo do Learn em nossa plataforma?
Não. A API do Catálogo do Learn fornece metadados sobre o conteúdo e links diretos para o conteúdo. Os usuários podem integrar esses links a qualquer LMS (Sistema de Gerenciamento de Aprendizagem) ou experiência da Web de acordo com os Termos de Uso da API da Microsoft .
P: Os dados retornados da API do Catálogo do Learn permanecem estáticos ou mudam?
Os dados são alterados sempre que novos conteúdos são adicionados, modificados ou excluídos, o que geralmente é diariamente.
Resposta da API
P: Posso pegar todos os dados de uma só vez?
Sim. Use o endpoint base no learn.microsoft.com/api/catalog, para obter a resposta completa. Consulte o artigo Learn Catalog API Developer Reference para obter mais informações de solicitação de API.
P: Posso pré-filtrar a resposta?
Sim. Consulte os filtros de consulta disponíveis no artigo de Referência do Desenvolvedor da API do Catálogo do Learn.
P: Os UIDs são exclusivos para cada objeto de conteúdo?
Sim. A UID significa "ID Exclusiva" e é exclusiva para cada objeto de conteúdo. Se uma UID for alterada, mesmo que o título ou outros metadados permaneça o mesmo, o conteúdo será considerado um novo objeto.
P: Por que há marcas HTML no resumo do módulo?
Normalmente, tentamos manter a formatação do resumo o mais bruto possível, mas às vezes precisamos enfatizar ou vincular determinado texto.
P: Por que não há links para as unidades individuais?
As unidades não são escritas como conteúdo independente. Eles estão destinados a serem realizados em uma ordem específica para o módulo. Por esse motivo, incluímos o link para a página de detalhes do módulo e a primeira unidade para que os usuários possam começar por lá e prosseguir com o conteúdo.
P: Como posso dizer qual é a novidade do conteúdo?
O valor last_modified informa quando o registro foi modificado pela última vez.
P: O SSO (Sign-On Único) está habilitado para os links de conteúdo?
Não neste momento. Pretendemos habilitar o SSO no futuro.
Conteúdo
P: a UID é exclusiva para conteúdo?
Sim. A UID significa "ID Exclusiva" e é exclusiva para cada objeto de conteúdo. Se uma UID for alterada, mesmo que o título ou outros metadados permaneça o mesmo, o conteúdo será considerado um novo objeto.
P: todos os módulos fazem parte de um roteiro de aprendizagem?
Não. Os módulos podem funcionar de forma independente, no sentido de que ensinam um cenário ou conceito completamente e não exigem a conclusão de módulos pré-requisitos. Para alguns, é isso e eles não fazem parte de um roteiro de aprendizagem. Para outros, eles são agrupados em um ou mais roteiros de aprendizagem que levam um usuário através da criação de conceitos mais avançados. Um módulo não precisa fazer parte de um roteiro de aprendizagem ou pode fazer parte de um ou mais.
P: Como saber quando o conteúdo foi adicionado, atualizado ou excluído?
Quando novos objetos de conteúdo são adicionados, eles aparecem como um novo objeto (identificado por UID) na resposta. Quando o conteúdo é modificado, você pode identificar com base em seu valor de last_modified. Quando o conteúdo é excluído, o objeto de conteúdo é removido da resposta. Embora às vezes haja um pequeno atraso no conteúdo que está sendo atualizado na resposta da API, quando um usuário segue a URL para o conteúdo, ele sempre vê as informações mais atuais. Quando o conteúdo for excluído, a URL antiga será redirecionada para o novo conteúdo ou experiência ou para a próxima melhor opção.
Notavelmente, o conteúdo está sendo atualizado o tempo todo. Publicamos atualizações disponíveis duas vezes por dia. Elas podem ser secundárias, como pequenas alterações de texto ou principais, como revisões principais, adições ou exclusões. Em geral, o portfólio de conteúdo é gerenciado como um projeto de software livre massivo e altamente controlado com milhares de colaboradores e, como tal, as alterações estão acontecendo o tempo todo. Se você usar a API do Catálogo do Learn em seu sistema de produção, deverá estar ciente disso e ter seu sistema capaz de lidar com isso.
P: Segui um link marcado para o conteúdo, mas agora ele está me mostrando um conteúdo diferente do que eu esperava. Por que?
Nos esforçamos para garantir que ninguém encontre um beco sem saída (404) ao acessar links para o nosso site. Quando o conteúdo é modificado ou substituído, implementamos um redirecionamento para o link antigo que o levará automaticamente ao novo conteúdo. Caso o conteúdo seja descontinuado e não seja substituído por vários motivos, redirecionaremos para o próximo melhor conteúdo apropriado, que pode ser um escopo ligeiramente modificado ou para uma página de destino, etc.
P: Como posso obter acesso aos catálogos de documentação, vídeo e amostras de código?
Não há nenhum método programático no momento para acessar esses catálogos. Pretendemos habilitar o acesso programático a esses catálogos no futuro.
Localização
P: quais idiomas estão disponíveis no Microsoft Learn?
Há mais de 65 localidades disponíveis no Microsoft Learn. Você pode ver uma lista completa aqui por meio do rodapé do site (selecione o idioma que você está exibindo para ver a lista completa).
P: o conteúdo está disponível em outros idiomas?
Depende. O objetivo é disponibilizar o conteúdo em todos os idiomas nos quais os produtos que estão sendo ensinados no conteúdo estão disponíveis. Quando os aprendizes visitam o site do Microsoft Learn em uma determinada localidade, se o conteúdo não estiver disponível nessa localidade, o usuário verá o cabeçalho e o rodapé na localidade desejada e o conteúdo principal retornará ao inglês até que uma versão localizada esteja disponível.
P: o conteúdo é diferente para um determinado objeto de conteúdo, dependendo da linguagem em que você o vê?
Possivelmente. Quando as atualizações são publicadas no conteúdo em inglês, nossos pipelines de localização funcionam para que as versões localizadas sejam atualizadas o mais rápido possível – geralmente dentro de alguns dias da alteração original.
Outro
P: há alguma API de relatório ou funcionalidade para obter dados, como exibições, cliques, conclusão?
Não temos uma API de relatório no momento. Temos funcionalidade de relatório organizacional que permite que as organizações gerem relatórios sobre as conclusões de seus usuários.
Próximas etapas
Você pode saber mais sobre a API do Catálogo do Learn visitando os seguintes links: