Perguntas frequentes sobre a API de Catálogo do Microsoft Learn
Este artigo lista as perguntas frequentes sobre a API de Catálogo do Microsoft Learn, com respostas e links para mais informações conforme necessário.
Geral
P: Quanto custa usar a API de Catálogo do Learn?
Não há nenhum custo para usar a API de Catálogo do Learn. Para obter mais informações, confira a seção Disponibilidade e Preços do artigo Visão geral do recurso API de Catálogo do Learn.
P: Quais são as regras de uso da API de Catálogo do Learn?
Confira os Termos de Uso do Microsoft Learn e das APIs da Microsoft.
P: Preciso integrar ou obter chaves para usar a API de Catálogo do Learn?
Não. A API está disponível publicamente. Confira o artigo Introdução à API de Catálogo do Learn usando o cURL e o Visual Studio Code e/ou o artigo Referência para desenvolvedores da API de Catálogo do Learn.
P: essa API permitirá que os usuários consumam o conteúdo do Learn dentro de nossa plataforma?
Não. A API de Catálogo do Learn fornece metadados sobre o conteúdo e links diretos para o conteúdo. Os usuários podem integrar esses links em qualquer Learning Management System (LMS) ou experiência na web de acordo com os Termos de Uso da API da Microsoft.
P: Os dados retornados da API de Catálogo do Learn permanecem estáticos ou são alterados?
Os dados são alterados sempre que novos conteúdos são adicionados, modificados ou excluídos, o que em geral ocorre diariamente.
Resposta da API
P: Posso obter todos os dados de uma só vez?
Sim. Use o ponto de extremidade base learn.microsoft.com/api/catalog para obter a resposta completa. Confira o artigo de referência para desenvolvedores da API de Catálogo do Learn para obter mais informações sobre solicitações de API.
P: Posso pré-filtrar a resposta?
Sim. Confira os filtros de consulta disponíveis no artigo de referência para desenvolvedores da API de Catálogo do Learn.
P: As UIDs são exclusivas para cada objeto de conteúdo?
Sim. 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çam iguais, 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 bruta 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 gravadas como conteúdo autônomo. Elas devem ser seguidas 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 lá e prosseguir com o conteúdo.
P: como saber qual conteúdo é novo?
O valor last_modified informa quando o registro foi modificado pela última vez.
P: O SSO (logon único) está habilitado para os links de conteúdo?
Não no momento. Nosso objetivo é habilitar o SSO no futuro.
Conteúdo
P: o UID é exclusivo para o conteúdo?
Sim. 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çam iguais, o conteúdo será considerado um novo objeto.
P: todos os módulos fazem parte de um roteiro de aprendizagem?
Não. Todos os módulos são autônomos, no sentido de ensinar um cenário ou conceito de ponta a ponta neles e não exigem a realização de módulos como pré-requisito. Para alguns deles, é assim, 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 a acompanhar a 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 fazer para 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 pelo UID) na resposta. Quando o conteúdo é modificado, é possível saber com base no valor last_modified. Quando o conteúdo é excluído, o objeto de conteúdo é removido da resposta. Embora às vezes haja um pequeno atraso na atualização do conteúdo na resposta da API, quando um usuário segue o URL do conteúdo, ele sempre vê as informações mais atuais. Quando o conteúdo é excluído, o URL antigo redirecionará para o novo conteúdo ou experiência, ou para a próxima melhor opção.
É preciso ressaltar que o conteúdo está sendo atualizado o tempo todo. Publicamos atualizações disponíveis duas vezes por dia. Elas podem ser menores, como pequenas alterações de texto ou grandes, como revisões, adições ou exclusões significativas. Em geral, o portfólio de conteúdo é gerenciado como um projeto de código aberto massivo e altamente controlado, com milhares de colaboradores e, como tal, as alterações acontecem o tempo todo. Se você usar a API de Catálogo do Learn em seu sistema de produção, deverá estar ciente disso e seu sistema deverá lidar com isso.
Q: Segui um link marcado para o conteúdo, mas agora ele está me mostrando um conteúdo diferente do que eu esperava. Por quê?
Nós nos esforçamos para garantir que ninguém chegue a um beco sem saída (404) com links para nosso site. Quando o conteúdo é modificado ou substituído, implementamos um redirecionamento para o link antigo que o levará automaticamente para o novo conteúdo. Caso o conteúdo seja obsoleto e não seja substituído por vários motivos, redirecionaremos para o próximo conteúdo mais apropriado, que pode ser um escopo ligeiramente modificado, ou para uma página de destino, etc.
P: Como fazer para obter acesso aos catálogos de documentação, vídeos e exemplos de código?
No momento, não há nenhuma forma que envolva programação de obter acesso a esses catálogos. Nosso objetivo é habilitar o acesso por meio de programação 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 no 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. Nosso objetivo é disponibilizar o conteúdo em todos os idiomas em que os produtos ensinados no conteúdo estão disponíveis. Quando os alunos 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 voltará 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 do idioma 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 em poucos dias após a alteração original.
Outro
P: Há alguma API de relatórios para funcionalidade para obter dados como exibições, cliques e conclusão?
No momento, não temos uma API de relatório. No entanto, temos a funcionalidade de relatórios organizacionais que permite que as organizações relatem as conclusões de seus usuários.
Próximas etapas
Você pode saber mais sobre a API de Catálogo do Learn visitando os seguintes links: