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 Learn Catalog?
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 Learn Catalog API.
P: Quais são as regras para usar a API do Catálogo do Learn?
Consulte os Termos de Uso do Microsoft Learn e da API da Microsoft.
P: Preciso integrar ou obter chaves para usar a API do Learn Catalog?
N.º A API está disponível publicamente. Consulte o artigo Introdução à API do Catálogo do Learn usando cURL e Visual Studio Code e/ou o artigo 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 dentro de nossa plataforma?
N.º 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 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 do Learn Catalog permanecem estáticos ou alterados?
Os dados mudam sempre que um novo conteúdo é adicionado, modificado ou excluído, o que geralmente é diário.
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. Consulte o artigo Learn Catalog API Developer Reference para obter mais informações sobre solicitações de API.
P: Posso pré-filtrar a resposta?
Sim. Consulte os filtros de consulta disponíveis no artigo Learn Catalog API Developer Reference.
P: Os UIDs são exclusivos para cada objeto de conteúdo?
Sim. UID significa "Unique ID" e é exclusivo para cada objeto de conteúdo. Se um UID for alterado, mesmo que o título ou outros metadados permaneçam os mesmos, o conteúdo será considerado um novo objeto.
P: Por que existem tags HTML no resumo do módulo?
Normalmente, tentamos manter a formatação do resumo o mais simples possível, mas às vezes precisamos de realçar ou associar determinado texto.
P: Porque é que não existem ligações para as unidades individuais?
As unidades não são escritas como conteúdo autónomo. Devem ser seguidas por uma ordem específica no módulo. Por este motivo, incluímos a ligação para a página de detalhes do módulo e a primeira unidade para que os utilizadores possam começar lá e prosseguir ao longo do conteúdo.
P: Como posso saber que conteúdo é novo?
O valor last_modified informa quando o registro foi modificado pela última vez.
P: O Single Sign-On (SSO) está habilitado para os links de conteúdo?
Neste momento, não. Nosso objetivo é habilitar o SSO no futuro.
Conteúdo
P: O UID é exclusivo para conteúdo?
Sim. UID significa "Unique ID" e é exclusivo para cada objeto de conteúdo. Se um UID for alterado, mesmo que o título ou outros metadados permaneçam os mesmos, o conteúdo será considerado um novo objeto.
P: todos os módulos fazem parte de um percurso de aprendizagem?
N.º Os módulos são todos capazes de ficar sozinhos, no sentido de que ensinam um cenário ou conceito de ponta a ponta dentro deles e não exigem módulos de pré-requisitos. Alguns não fazem parte de um percurso de aprendizagem. Outros estão agrupados num ou em mais percursos de aprendizagem que levam um utilizador a acompanhar a criação de conceitos mais avançados. Um módulo não precisa de fazer parte de um percurso de aprendizagem ou pode fazer parte de um ou mais.
P: Como sei 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, você pode saber com base em seu 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 a URL do conteúdo, ele sempre vê as informações mais atuais. Quando o conteúdo é excluído, o URL antigo redireciona 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. Podem ser menores, como pequenas alterações de texto, ou maiores, como grandes revisões, adições ou exclusões. Em geral, o portfólio de conteúdo é gerenciado como um projeto de código aberto massivo e altamente governado com milhares de contribuidores e, como tal, mudanças estão acontecendo o tempo todo. Se você usa a API do Learn Catalog em seu sistema de produção, deve estar ciente disso e ter seu sistema capaz de lidar com isso.
P: Eu segui um link marcado para o conteúdo, mas ele agora está me mostrando um conteúdo diferente do que eu esperava. Porquê?
Nós nos esforçamos para garantir que ninguém chegue a um beco sem saída (404) com links para o 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 preterido 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 faço para obter acesso aos catálogos de documentação, vídeo e exemplo de código?
Não há nenhuma maneira programática no momento para ter acesso a esses catálogos. Pretendemos permitir o acesso programático a estes catálogos no futuro.
Localização
P: Que idiomas estão disponíveis no Microsoft Learn?
Há mais de 65 localidades disponíveis no Microsoft Learn. Pode ver uma lista completa aqui através do rodapé do site (selecione o idioma que está a visualizar para ver a lista completa).
P: O conteúdo está disponível noutras línguas?
Depende. Nosso objetivo é disponibilizar o conteúdo em todas as línguas em que os produtos que estão sendo 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á para 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 visualiza?
Talvez. Quando as atualizações são publicadas para o conteúdo em inglês, nossos pipelines de localização trabalham para que as versões localizadas sejam atualizadas o mais rápido possível – geralmente dentro de alguns dias após a alteração original.
Outro
P: Existe alguma API ou funcionalidade de relatório para obter dados, como visualizações, cliques, conclusão?
No momento, não temos uma API de relatórios. Temos a funcionalidade de relatórios organizacionais que permite que as organizações relatem sobre as finalizações de seus usuários.
Próximos passos
Você pode saber mais sobre a API do catálogo Learn visitando os seguintes links: