Documentação de referência do desenvolvedor da API do Catálogo do Microsoft Learn
Este artigo fornece informações para desenvolvedores e solicitantes que implementam a API do Catálogo do Microsoft Learn. Também recomendamos verificar as práticas recomendadas da API do Learn Catalog, as notas de versão e os artigos de perguntas freqüentes para apoiar sua jornada de desenvolvimento.
Ponto final de API
A API do Catálogo do Microsoft Learn é uma API da Web baseada em REST que retorna uma resposta codificada em JSON. Para solicitar o catálogo completo, envie um pedido GET para:
https://learn.microsoft.com/api/catalog/
Nota
O ponto final listado acima é o ponto final atual. Se estiver a utilizar um ponto final diferente e mais antigo ainda funcionará conforme esperado quando fez a integração, mas os benefícios de migrar para o novo ponto final são as funcionalidades avançadas, como parâmetros de consulta adicionais.
Parâmetros de consultas
Veja a seguir os parâmetros de consulta que o pedido pode incluir. Todos são opcionais. Tem de codificar com URL os valores dos parâmetros de consulta. Pode utilizar o ponto final com nenhum, um, alguns ou todos estes parâmetros.
Importante
Se utilizar mais do que um, a consulta será avaliada com o operador AND.
| Nome | Valor | Tipo | Obrigatório | Exemplo |
|---|---|---|---|---|
| região | Um código de região único válido da lista de regiões suportadas. Os metadados devolvidos estarão na região solicitada, se disponível. Se este parâmetro não for fornecido, será devolvida a resposta en-us. |
string | Não | ?locale=en-us |
| tipo | Uma lista separada por vírgulas de um ou mais objetos de conteúdo ou taxonomias de nível superior que fornecemos atualmente na resposta a devolver. Os valores suportados são: modules, , , , , , , , , , , certificationsmergedCertificationsexamsunitslevelslearningPathsproductsappliedSkillsrolescoursessubjects. |
string | Não | ?type=modules,learningPaths |
| uid | Uma lista separada por vírgulas de um ou mais IDs exclusivos (UID) de conteúdo válidos dos tipos de conteúdo disponíveis. Nota: os UIDs são sensíveis às maiúsculas e minúsculas. | string | Não | ?uid=learn.azure.intro-to-azure-fundamentals |
| last_modified | Um operador e datetime para filtrar pela data da última modificação de objetos. O operador inclui lt (menor que), lte (menor ou igual a), eq (igual a), gt (maior que), gte (maior ou igual a). Quando utilizar este parâmetro, o operador utilizará como predefinição gte, se não for especificado. |
string | Não | ?last_modified=gte 2022-01-01 |
| popularity | Um operador e um valor para filtrar pelo valor de popularidade (num intervalo de 0 a 1) de objetos. O operador inclui lt (menor que), lte (menor ou igual a), eq (igual a), gt (maior que), gte (maior ou igual a). Quando utilizar este parâmetro, o operador utilizará como predefinição gte, se não for especificado. |
string | Não | ?popularity=gte 0.5 |
| nível | Uma lista separada por vírgulas de um ou mais níveis que temos atualmente disponíveis (a lista completa está no objeto levels da resposta da API). | string | Não | ?level=beginner |
| função | Uma lista separada por vírgulas de uma ou mais funções que temos atualmente disponíveis (a lista completa está no objeto roles da resposta da API). | string | Não | ?role=developer |
| produto | Uma lista separada por vírgulas de uma ou mais funções que temos atualmente disponíveis (a lista completa está no objeto products da resposta da API). A API não suporta hierarquia de produtos, portanto, adicione todos os produtos à lista que você deseja incluir em sua consulta. | string | Não | ?product=azure |
| requerente | Uma lista separada por vírgulas de uma ou mais funções que temos atualmente disponíveis (a lista completa está no objeto subjects da resposta da API). A API não suporta hierarquia de assuntos, portanto, adicione todos os assuntos à lista que você deseja incluir em sua consulta. | string | Não | ?subject=cloud-computing |
Consultas de exemplo
As consultas listadas abaixo são exemplos para ajudá-lo a ter uma noção do que pode solicitar e como formar o pedido.
| Descrição | Consulta |
|---|---|
| Todos os itens na API de Catálogo do Learn | https://learn.microsoft.com/api/catalog/ |
| Todos os módulos em espanhol | https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules |
| Todos os módulos com uma classificação de popularidade igual ou superior a 0,9 | https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9 |
| Todos os objetos de formação e certificação de segurança para iniciantes | https://learn.microsoft.com/api/catalog/?level=beginner&subject=security |
| Todos os módulos de acessibilidade avançados com uma classificação de popularidade acima de 0,5 e atualizados no último mês | https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01 |
Resposta da API
O serviço pode devolver os seguintes códigos de estado HTTP.
| Código de estado | Descrição |
|---|---|
| 200 | Êxito. O corpo da resposta inclui os dados codificados em JSON. |
| 400 | Um dos parâmetros de consulta está em falta ou não é válido. |
| 404 | O URL não foi encontrado no servidor. |
| 500 | Erro de servidor inesperado. |
| 503 | O serviço está temporariamente indisponível. |
Uma resposta com êxito incluirá detalhes sobre todos os módulos e percursos de aprendizagem, conforme apresentado abaixo.
Corpo da resposta
Um corpo de resposta bem-sucedido será codificado em JSON e terá 12 seções:
{
"modules": [ ... ],
"units": [...],
"learningPaths": [ ... ],
"appliedSkills": [ ... ],
"mergedCertifications": [ ... ],
"certifications": [ ... ],
"exams": [ ... ],
"courses": [ ... ],
"levels": [ ... ],
"products": [ ... ],
"roles": [ ... ],
"subjects": [...],
}
Cada matriz tem um ou mais objetos codificados em JSON que contêm dados específicos dessa secção da resposta.
modules: é uma matriz de módulos publicados.units: é uma matriz de unidades publicadas.learningPaths: é uma matriz de percursos de aprendizagem publicados.appliedSkills: é um conjunto de competências aplicadas publicadas.mergedCertifications: é uma série de certificações publicadas mescladas com exames.certifications: é uma matriz de certificações publicadas.exams: é uma matriz de exames publicados.courses: é uma matriz de cursos de formação orientados por formadores.levels: é uma matriz de possíveis níveis de audiência.products: é uma matriz de produtos e serviços possíveis abrangidos no catálogo.roles: é uma matriz de possíveis funções.subjects: é uma matriz de possíveis etiquetas de assuntos.
Registos de módulo
Registos de módulo
Cada registo de módulo terá o seguinte formato:
{
"summary": "Explore the core concepts of cloud computing and how it can help your business.",
"levels": [
"beginner"
],
"roles": [
"administrator",
"business-analyst",
"developer"
],
"products": [
"azure",
"azure-portal",
"azure-resource-manager"
],
"subjects": [
"data-visualization"
],
"uid": "learn.principles-cloud-computing",
"type": "module",
"title": "Cloud Concepts - Principles of cloud computing",
"duration_in_minutes": 62,
"rating": {
count: 2014,
average: 4.84
},
"popularity": 0.8839785477023878,
"icon_url": "https://learn.microsoft.com/learn/achievements/principles-cloud-computing.svg",
"social_image_url": "https://learn.microsoft.com/learn/achievements/principles-cloud-computing-social.png",
"locale": "en-us",
"last_modified": "2018-09-24T00:00:00Z",
"url": "https://learn.microsoft.com/learn/modules/principles-cloud-computing",
"firstUnitUrl": "https://learn.microsoft.com/learn/modules/principles-cloud-computing/1-introduction",
"units": [
"learn.principles-cloud-computing.1-introduction",
"learn.principles-cloud-computing.2-types-of-cloud-computing",
"learn.principles-cloud-computing.3-benefits-of-cloud-computing",
"learn.principles-cloud-computing.4-categories-of-cloud-services",
"learn.principles-cloud-computing.5-knowledge-check",
"learn.principles-cloud-computing.6-summary"
],
"number_of_children": 6
}
Detalhes do campo
| Campo | Tipo | Descrição |
|---|---|---|
summary |
string | Uma cadeia de carateres que fornece uma breve descrição do módulo. O valor é expresso como uma tag de parágrafo HTML e o texto interno é o resumo. |
levels |
matriz de cadeias | Uma lista dos níveis associados a este módulo, que indicam quanta experiência na função é necessária para compreender todos os aspetos deste módulo. Os detalhes sobre as unidades podem ser referenciados nos registos de níveis. |
roles |
matriz de cadeias | Uma lista das funções para as quais este módulo é relevante. |
products |
matriz de cadeias | Uma lista de produtos relevantes que este módulo aborda. Os detalhes sobre os produtos podem ser referenciados nos registos de produtos. |
subjects |
matriz de cadeias | Uma lista de assuntos relevantes abordados por este percurso de aprendizagem. |
uid |
string | Um identificador exclusivo para este módulo – este valor será exclusivo em todo o MS Learn. |
type |
string | O tipo de registo. O valor será sempre "module". |
title |
string | O título do módulo na região solicitada ou em inglês dos Estados Unidos como alternativa. |
duration_in_minutes |
integer | O tempo médio em minutos que este módulo demora a ser concluído. |
rating |
objeto | Contém count, que é o número de pessoas que classificaram o módulo, e average, uma agregação das classificações, que será de 1 a 5 |
popularity |
duplo | Um valor normalizado de 0-1 que indica a popularidade do módulo |
icon_url |
string | Um URL completamente qualificado para uma imagem SVG 100 x 100 que representa a imagem de conquista do módulo com um fundo transparente. |
social_image_url |
string | Um URL completamente qualificado para uma imagem PNG que representa a imagem de conquista do módulo com um fundo opaco retangular, adequado para redes sociais ou mosaicos. Se não estiver disponível para este módulo, esta propriedade não será devolvida na resposta. |
locale |
string | O idioma em que estes dados JSON estão escritos. Este valor será a região solicitada se estiver disponível ou "en-us" se não estiver. |
last_modified |
data | A última vez que este módulo foi submetido a uma revisão importante. |
url |
string | Um URL completamente qualificado para o módulo do Learn na região pedida. |
firstUnitUrl |
string | Um URL completamente qualificado para a primeira unidade do módulo do Learn na região pedida. |
units |
matriz de cadeias | Uma lista dos UIDs de unidades associados. Os detalhes sobre as unidades podem ser referenciados nos registos de unidades. |
number_of_children |
integer | O número de páginas (unidades) que este módulo contém. |
Registos de unidades
Cada registo de unidade terá o seguinte formato:
{
"uid": "learn.azure.fundamental-azure-concepts.types-of-cloud-computing",
"type": "unit",
"title": "Discuss different types of cloud models",
"duration_in_minutes": 5,
"locale": "en-us",
"last_modified": "2021-12-09T02:45:00+00:00"
},
Nota
O registo de unidade não tem o URL associado, porque as unidades não são escritas como conteúdo autónomo. Devem ser obtidas por uma ordem específica para o módulo. Por este motivo, incluímos a ligação para a página de detalhes do módulo e a primeira unidade no registo de módulos para que os utilizadores possam começar lá e prosseguir ao longo do conteúdo. No entanto, os registos de unidades podem ser utilizados para obter detalhes sobre as unidades a apresentar em LMSs ou noutras experiências.
Detalhes do campo
| Campo | Tipo | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para este módulo – este valor será exclusivo em todo o MS Learn. |
type |
string | O tipo de registo. O valor será sempre "unit". |
title |
string | O título da unidade na região pedida ou em inglês dos EUA como um fallback. |
duration_in_minutes |
A duração da unidade. Se somar todos os duration_in_minutes das unidades associadas a cada módulo, irá obter o tempo total do módulo. | |
locale |
string | O idioma em que estes dados JSON estão escritos. Este valor será a região solicitada se estiver disponível ou "en-us" se não estiver. |
last_modified |
data | A última vez que este módulo foi submetido a uma revisão importante. |
Registos de percurso de aprendizagem
Cada registo de percurso de aprendizagem terá o seguinte formato:
{
"summary": "Azure Functions enable the creation of event driven, compute-on-demand systems that can be triggered by various external events. Learn how to leverage functions to execute server-side logic and build serverless architectures.",
"levels": [
"beginner",
"intermediate"
],
"roles": [
"developer",
"solution-architect"
],
"products": [
"azure",
"azure-portal",
"azure-functions",
"azure-cosmos-db",
"azure-cloud-shell"
],
"subjects": [
"data-visualization"
],
"uid": "learn.create-serverless-applications",
"type": "learningPath",
"title": "Create serverless applications",
"duration_in_minutes": 450,
"rating": {
count: 2014,
average: 4.84
},
"popularity": 0.8839785477023878,
"icon_url": "https://learn.microsoft.com/learn/achievements/create-serverless-applications.svg",
"social_image_url": "https://learn.microsoft.com/learn/achievements/create-serverless-applications-social.png",
"locale": "en-us",
"last_modified": "2018-12-27T00:00:00Z",
"url": "https://learn.microsoft.com/learn/paths/create-serverless-applications",
"firstModuleUrl": "https://learn.microsoft.com/learn/modules/choose-azure-service-to-integrate-and-automate-business-processes/",
"modules": [
"learn.choose-azure-service-to-integrate-and-automate-business-processes",
"learn.create-serverless-logic-with-functions",
"learn.execute-azure-function-with-triggers",
"learn.chain-azure-functions-data-using-input-output-bindings",
"learn.azure-create-long-running-serverless-workflow-with-durable-functions",
"learn-pr.develop-test-deploy-azure-functions-core-tools",
"learn.develop-test-deploy-azure-functions-with-visual-studio",
"learn.azure.monitor-github-events-with-a-function-triggered-by-a-webhook",
"learn.advocates.azure-functions-and-signalr"
],
"number_of_children": 9
}
Detalhes do campo
| Campo | Tipo | Descrição |
|---|---|---|
summary |
string | Uma cadeia de carateres que fornece uma breve descrição do percurso de aprendizagem. O valor é expresso como uma tag de parágrafo HTML e o texto interno é o resumo. |
levels |
matriz de cadeias | Uma lista dos níveis associados a este percurso de aprendizagem, que indicam quanta experiência na função é necessária para compreender todos os aspetos deste percurso de aprendizagem. Os detalhes sobre as unidades podem ser referenciados nos registos de níveis. |
roles |
matriz de cadeias | Uma lista das funções relevantes para este percurso de aprendizagem. |
products |
matriz de cadeias | Uma lista de produtos relevantes que este percurso de aprendizagem aborda. Os detalhes sobre os produtos podem ser referenciados nos registos de produtos. |
subjects |
matriz de cadeias | Uma lista de assuntos relevantes abordados por este percurso de aprendizagem. |
uid |
string | Um identificador exclusivo para este percurso de aprendizagem – este valor será exclusivo em todo o MS Learn. |
type |
string | O tipo de registo. O valor será sempre "learningPath". |
title |
string | O título do percurso de aprendizagem na região solicitada ou em inglês dos Estados Unidos como alternativa. |
duration_in_minutes |
integer | O tempo médio em minutos que este percurso de aprendizagem demora a ser concluído. Este valor é a soma dos dados de todos os módulos incluídos. |
rating |
objeto | Contém count, que é o número de pessoas que classificaram o percurso de aprendizagem, e average, uma agregação das classificações, que será de 1 a 5 |
popularity |
duplo | Um valor normalizado de 0-1 que indica a popularidade do percurso de aprendizagem |
icon_url |
string | Um URL completamente qualificado para uma imagem SVG 100 x 100 que representa o percurso de aprendizagem. |
social_image_url |
string | Um URL completamente qualificado para uma imagem PNG que representa a imagem de conquista do percurso de aprendizagem com um fundo opaco retangular, adequado para redes sociais ou mosaicos. Se não estiver disponível para este módulo, esta propriedade não será devolvida na resposta. |
locale |
string | O idioma em que estes dados JSON estão escritos. Este valor será a região solicitada se estiver disponível ou "en-us" se não estiver. |
last_modified |
data | A última vez que este percurso de aprendizagem foi alterado. |
url |
string | Um URL completamente qualificado para o percurso de aprendizagem no Microsoft Learn na região solicitada. |
firstModuleUrl |
string | Um URL completamente qualificado para o primeiro módulo do percurso de aprendizagem no Microsoft Learn na região pedida. |
modules |
matriz de cadeias | Uma lista dos UIDs de módulos associados. Os detalhes sobre os módulos podem ser referenciados nos registos de módulos. |
number_of_children |
integer | O número de módulos que este percurso de aprendizagem contém. |
Registos de Competências Aplicadas
Cada registo de Competências Aplicadas terá a seguinte forma:
{
"uid": "applied-skill.deploy-and-configure-azure-monitor",
"locale": "en-us",
"url": "https://learn.microsoft.com/en-us/credentials/applied-skills/deploy-and-configure-azure-monitor/?WT.mc_id=api_CatalogApi",
"title": "Deploy and configure Azure Monitor",
"summary": "<p>To earn this Microsoft Applied Skills credential, learners demonstrate the ability to deploy and configure monitoring for Azure infrastructure.</p>\n<p>Candidates for this assessment lab should be familiar with operating systems, networking, servers, and virtualization.</p>\n",
"levels": [
"intermediate"
],
"roles": [
"administrator"
],
"products": [
"azure-monitor",
"azure-virtual-machines",
"azure-virtual-network",
"windows-server"
],
"subjects": [
"it-management-monitoring"
],
"study_guide": [
{
"uid": "learn.wwl.deploy-configure-azure-monitor",
"type": "learningPath"
}
],
"last_modified": "2023-10-25T17:07:00+00:00"
}
Detalhes do campo
| Campo | Tipo | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para esta Habilidade Aplicada - este valor será único em todo o MS Learn. |
locale |
string | O idioma em que estes dados JSON estão escritos. Este valor será a região solicitada se estiver disponível ou "en-us" se não estiver. |
title |
string | O título para a Habilidade Aplicada na localidade solicitada, ou Inglês dos EUA como um fallback. |
summary |
string | O resumo da Habilidade Aplicada na localidade solicitada ou o inglês dos EUA como fallback. |
url |
string | Uma URL totalmente qualificada para a Habilidade Aplicada no Microsoft Learn na localidade solicitada. |
icon_url |
string | Um URL totalmente qualificado para uma imagem SVG 100x100 que representa a Habilidade Aplicada (quando disponível, de outra forma não incluída). |
levels |
matriz de cadeias | Uma lista dos níveis associados a esta Habilidade Aplicada. |
roles |
matriz de cadeias | Uma lista das funções relevantes para esta Habilidade Aplicada. Os detalhes sobre as funções podem ser referenciados nos registos de funções. |
subjects |
matriz de cadeias | Uma lista de assuntos relevantes que esta Habilidade Aplicada abrange. |
study_guide |
matriz de objetos | Uma lista dos conteúdos associados a estudar para esta Habilidade Aplicada. Os detalhes sobre os objetos podem ser referenciados nos registos associados. |
last_modified |
data | A última vez que esta Habilidade Aplicada foi alterada. |
Registros de certificação mesclados
Cada registro de certificação mesclado terá o seguinte formulário:
{
"uid": "certification.d365-functional-consultant-manufacturing",
"title": "Microsoft Certified: Dynamics 365 Supply Chain Management, Manufacturing Functional Consultant Associate",
"summary": "<div class=\"WARNING\">\n<p>Warning</p>\n<p>This certification retired on June 30, 2023. You can renew it for at least six months after the retirement date by completing the free online assessment available on the <a href=\"/credentials/certifications/d365-functional-consultant-manufacturing/renew\">certification renewal page</a>. <a href=\"https://aka.ms/BACertPortfolioUpdatesBlog\">Read the blog post</a>.</p>\n</div>\n<p>If you’re a functional consultant or a business user with a deep understanding of manufacturing industry standards, this certification might be for you. You also need experience configuring and implementing Dynamics 365 Supply Chain Management to meet the needs of your organization. Supply chain management, manufacturing functional consultants are key resources who work with developers, solution architects, project managers, and functional consultants in finance, commerce, and supply chain.</p>\n<p>If you need more experience before you try to earn this certification, here are some suggestions:</p>\n<ul>\n<li>Study the supply chain management and supply chain management, manufacturing modules on Microsoft Learn, and complete more hands-on practice.</li>\n<li>Sign up for an instructor-led training course that covers the MB-300 or MB-320 track.</li>\n<li>Take part in the community at <a href=\"https://community.dynamics.com/\">community.dynamics.com</a>, or join a user group.</li>\n<li>Shadow a manufacturing functional consultant in a manufacturing workstream.</li>\n<li>Get a mentor, tour manufacturing lines, and learn how things are made.</li>\n<li>Ask questions, and learn from experts and customers.</li>\n</ul>\n",
"url": "https://learn.microsoft.com/en-us/credentials/certifications/d365-functional-consultant-manufacturing/?WT.mc_id=api_CatalogApi",
"icon_url": "https://learn.microsoft.com/en-us/media/learn/certification/badges/microsoft-certified-associate-badge.svg",
"last_modified": "2023-09-19T00:47:00+00:00",
"type": "cert",
"certification_type": "role-based",
"products": [
"dynamics-365",
"dynamics-finance"
],
"levels": [
"intermediate"
],
"roles": [
"functional-consultant"
],
"subjects": [],
"renewal_frequency_in_days": 0,
"prerequisites": [],
"skills": [
"Describe finance and operations apps, and extend apps by using Microsoft Power Platform technologies",
"Configure administrative features and workflows",
"Manage finance and operations data",
"Validate and support solutions",
"Configure Dynamics 365 Supply Chain Management, Manufacturing",
"Manage manufacturing processes",
"Implement master planning for production",
"Implement other manufacturing features"
],
"recommendation_list": [],
"study_guide": [],
"exam_duration_in_minutes": 0,
"locales": [],
"providers": [],
"career_paths": []
}
Detalhes do campo
| Campo | Tipo | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para esta certificação – este valor será exclusivo em todo o MS Learn. |
title |
string | O título da certificação na região pedida ou em inglês dos EUA como um fallback. |
summary |
string | O resumo da certificação na localidade solicitada ou o inglês dos EUA como fallback. |
url |
string | Um URL completamente qualificado para a certificação no Microsoft Learn na região pedida. |
icon_url |
string | Um URL completamente qualificado para uma imagem SVG 100 x 100 que representa a certificação. |
last_modified |
data | A última vez que esta certificação foi alterada. |
type |
string | O tipo de registo. O valor será sempre "cert". |
certification_type |
string | O tipo de certificação. Os valores possíveis são "fundamentals", "mce", "mcsa", "mcsd", "mcse", "mos", "mta", "role-based", "specialty". |
products |
matriz de cadeias | Uma lista de produtos relevantes abrangidos por esta certificação. Os detalhes sobre os produtos podem ser referenciados nos registos de produtos. |
levels |
matriz de cadeias | Uma lista dos níveis associados a esta certificação, que indicam quanta experiência na função é necessária para compreender todos os aspetos dos exames desta certificação. Os detalhes sobre as unidades podem ser referenciados nos registos de níveis. |
roles |
matriz de cadeias | Uma lista das funções de trabalho relevantes para esta certificação. Os detalhes sobre as funções podem ser referenciados nos registos de funções. |
subjects |
matriz de cadeias | Uma lista de assuntos relevantes que esta certificação abrange. |
renewal_frequency_in_days |
integer | O número de dias antes desta certificação expira e precisa ser renovado. Se o valor for 0, a certificação não expira. |
prerequisites |
matriz de cadeias | Uma lista dos pré-requisitos recomendados para obter esta certificação. Os detalhes sobre as certificações podem ser consultados nos registos de certificação. |
skills |
matriz de cadeias | Uma lista das habilidades medidas no exame exigido para esta certificação. |
recommendation_list |
matriz de cadeias | Uma lista das recomendações relacionadas com esta certificação. |
study_guide |
matriz de objetos | Uma lista dos conteúdos associados a serem estudados para esta certificação. Os detalhes sobre os objetos podem ser referenciados nos registos associados. |
exam_duration_in_minutes |
integer | O número de minutos atribuídos para concluir o exame. |
locales |
matriz de cadeias | Uma lista dos idiomas em que esta certificação é oferecida. |
providers |
matriz de objetos | Uma lista de fornecedores para esta certificação. O tipo descreve o fornecedor e um URL completamente qualificado com uma ligação para agendamento de um exame no fornecedor. |
career_paths |
matriz de objetos | Uma lista de planos de carreira para esta certificação. |
Nota
As certificações que exigem apenas um exame serão retornadas como parte dessa propriedade mergedCertifications.
Registos de certificações
Cada registo de certificação terá o seguinte formato:
{
"uid": "certification.d365-functional-consultant-customer-service",
"title": "Microsoft Certified: Dynamics 365 Customer Service Functional Consultant Associate",
"subtitle": "Microsoft Dynamics 365 Customer Service functional consultants are responsible for implementing omnichannel solutions that focus on service, quality, reliability, efficiency, and customer satisfaction.",
"url": "https://learn.microsoft.com/cert-exam-sandbox/cert/?WT.mc_id=api_CatalogApi",
"icon_url": "https://learn.microsoft.com/media/learn/certification/badges/microsoft-certified-associate-badge.svg",
"type": "cert",
"certification_type": "role-based",
"exams": [
"exam.77-881"
],
"levels": [
"intermediate"
],
"roles": [
"functional-consultant"
],
"study_guide": [
{
"uid": "learn.get-started-with-d365",
"type": "module"
},
{
"uid": "learn.d365-notebook",
"type": "module"
},
{
"uid": "learn.d365-fundamentals",
"type": "learningPath"
}
]
}
Detalhes do campo
| Campo | Tipo | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para esta certificação – este valor será exclusivo em todo o MS Learn. |
title |
string | O título da certificação na região pedida ou em inglês dos EUA como um fallback. |
subtitle |
string | O subtítulo da certificação na região pedida ou em inglês dos EUA como um fallback. |
url |
string | Um URL completamente qualificado para a certificação no Microsoft Learn na região pedida. |
icon_url |
string | Um URL completamente qualificado para uma imagem SVG 100 x 100 que representa a certificação. |
type |
string | O tipo de registo. O valor será sempre "cert". |
certification_type |
string | O tipo de certificação. Os valores possíveis são "fundamentals", "mce", "mcsa", "mcsd", "mcse", "mos", "mta", "role-based", "specialty". |
exams |
matriz de cadeias | Uma lista dos exames associados necessários para esta certificação. Os detalhes sobre as unidades podem ser referenciados nos registos de certificações. |
levels |
matriz de cadeias | Uma lista dos níveis associados a esta certificação, que indicam quanta experiência na função é necessária para compreender todos os aspetos dos exames desta certificação. Os detalhes sobre as unidades podem ser referenciados nos registos de níveis. |
roles |
matriz de cadeias | Uma lista das funções de trabalho relevantes para esta certificação. Os detalhes sobre as funções podem ser referenciados nos registos de funções. |
study_guide |
matriz de objetos | Uma lista dos conteúdos associados a serem estudados para esta certificação. Os detalhes sobre os objetos podem ser referenciados nos registos associados. |
Nota
As certificações que exigem mais de um exame estarão presentes neste registro de certificações referenciando a matriz de exames.
Registos de exames
Cada registo de exame terá o seguinte formato:
{
"uid": "exam.77-881",
"title": "Word 2010",
"subtitle": "The core-level Microsoft Office Word 2010 user should be able to navigate Microsoft Office Word 2010 software at the feature and functional level. They should be familiar with and know how to use at least 80 percent of the features and capabilities of Microsoft Office Word 2010. The core-level user should be able to use Microsoft Office Word 2010 to create and edit professional-looking documents for a variety of purposes and situations. Users would include people from a wide variety of job roles from almost all areas of professional, student, and personal life.",
"display_name": "77-881",
"url": "https://learn.microsoft.com/cert-exam-sandbox/exam/77-881/?WT.mc_id=api_CatalogApi",
"icon_url": "https://learn.microsoft.com/media/learn/certification/badges/certification-exam.svg",
"pdf_download_url": "https://query.prod.cms.rt.microsoft.com/cms/api/am/binary/RE4trjX",
"practice_test_url": "https://www.mindhub.com/70-413-Designing-and-Implementing-a-Server-Infrast-p/mu-70-413_p.htm?utm_source=microsoft&utm_medium=certpage&utm_campaign=msofficialpractice",
"practice_assessment_url": "https://learn.microsoft.com/en-us/certifications/exams/{exam}/practice/assessment?assessment-type=practice&assessmentId={assessmentId}",
"locales": [],
"type": "exam",
"courses": [
"course.pl-200t00",
"course.mb-230t01"
],
"levels": [
"beginner"
],
"roles": [
"business-user"
],
"products": [
"office-word"
],
"providers": [],
"study_guide": [
{
"uid": "learn.get-started-with-word-2010",
"type": "module"
},
{
"uid": "learn.office2010-notebook",
"type": "module"
},
{
"uid": "learn.office2010-fundamentals",
"type": "learningPath"
}
]
}
Detalhes do campo
| Campo | Tipo | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para este exame – este valor será exclusivo em todo o MS Learn. |
title |
string | O título do exame na região pedida ou em inglês dos EUA como um fallback. |
subtitle |
string | O subtítulo do exame na região pedida ou em inglês dos EUA como um fallback. |
display_name |
string | O nome a apresentar do exame na região pedida ou em inglês dos EUA como um fallback. |
url |
string | Um URL completamente qualificado para o exame no Microsoft Learn na região pedida. |
icon_url |
string | Um URL completamente qualificado para uma imagem SVG 100 x 100 que representa o exame. |
pdf_download_url |
string | Um URL completamente qualificado para o PDF que descreve as competências medidas por este exame. |
practice_test_url |
string | Um URL completamente qualificado para um teste prático associado ao exame. |
practice_assessment_url |
string | Um URL totalmente qualificado para uma avaliação prática gratuita associada ao exame. |
locales |
matriz de cadeias | Uma lista de idiomas em que este exame é disponibilizado. |
type |
string | O tipo de registo. O valor será sempre "exam". |
courses |
matriz de cadeias | Uma lista dos UIDs de cursos associados. Os detalhes sobre os cursos podem ser referenciados nos registos de cursos. |
levels |
matriz de cadeias | Uma lista dos níveis associados a este exame, que indicam quanta experiência na função é necessária para compreender todos os aspetos deste exame. Os detalhes sobre as unidades podem ser referenciados nos registos de níveis. |
roles |
matriz de cadeias | Uma lista das funções de trabalho relevantes para este exame. Os detalhes sobre as funções podem ser referenciados nos registos de funções. |
products |
matriz de cadeias | Uma lista dos produtos relevantes abrangidos por este exame. Os detalhes sobre os produtos podem ser referenciados nos registos de produtos. |
providers |
matriz de objetos | Uma lista de fornecedores para este exame. O tipo descreve o fornecedor e um URL completamente qualificado com uma ligação para agendamento de um exame no fornecedor. |
study_guide |
matriz de objetos | Uma lista dos conteúdos associados a serem estudados para este exame. Os detalhes sobre os objetos podem ser referenciados nos registos associados. |
Registos de cursos orientados por formadores
Cada registo de curso terá o seguinte formato:
{
"uid": "course.mb-230t01",
"course_number": "MB-230T01",
"title": "Microsoft Dynamics 365 Customer Service - added non-exist studyguide",
"summary": "Microsoft Dynamics 365 Customer Service offers any organization an opportunity for customer success. Using tools such as automatic case creation and queue management frees up your time to dedicate it where you can have a greater impact, directly with your customers. Join our team of globally recognized experts as they take you step by step from creating cases to interacting with customers to resolving those cases. Once you’ve resolved those cases you can learn from data analysis the key details to help you resolve similar cases faster or avoid new issues altogether. A Dynamics 365 Customer Engagement Functional Consultant is responsible for performing discovery, capturing requirements, engaging subject matter experts and stakeholders, translating requirements, and configuring the solution and applications. The Functional Consultant implements a solution using out of the box capabilities, codeless extensibility, application and service integrations.",
"duration_in_hours": 72,
"url": "https://learn.microsoft.com/cert-exam-sandbox/course/mb-230t01/?WT.mc_id=api_CatalogApi",
"icon_url": "https://learn.microsoft.com/media/learn/certification/course.svg",
"locales": [
"en"
],
"type": "course",
"certification": "certification.d365-functional-consultant-customer-service",
"exam": "exam.77-881",
"levels": [
"intermediate"
],
"roles": [
"functional-consultant"
],
"products": [
"dynamics-365"
],
"study_guide": [
{
"uid": "learn.align-requirements-in-azure",
"type": "module"
},
{
"uid": "learn.manage-resources-in-azure",
"type": "learningPath"
}
]
},
Detalhes do campo
| Campo | Tipo | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para este curso orientado por formador – este valor será exclusivo em todo o MS Learn. |
course_number |
string | O identificador do número do curso orientado por formador. |
title |
string | O título do curso orientado por formador na região pedida ou em inglês dos EUA como um fallback. |
summary |
string | Uma cadeia de carateres que fornece uma breve descrição do curso orientado por formador. O valor é expresso como uma tag de parágrafo HTML e o texto interno é o resumo. |
duration_in_hours |
integer | O tempo médio que o curso orientado por formador demora a ser concluído em horas. |
url |
string | Um URL completamente qualificado para a página de detalhes do curso orientado por formador no Microsoft Learn na região pedida. |
icon_url |
string | Um URL completamente qualificado para uma imagem SVG 100 x 100 que representa a conquista do curso orientado por formador. |
locales |
matriz de cadeias | Uma lista de idiomas em que este curso orientado por formador é oficialmente disponibilizado. Pode haver outros idiomas suportados pelos parceiros de aprendizagem. |
type |
string | O tipo de registo. O valor será sempre "course" para cursos orientados por formadores. |
certification |
string | Certificação associada ao curso orientado por formador. |
exam |
string | Exame associado ao curso orientado por formador. |
levels |
matriz de cadeias | Uma lista dos níveis associados a este curso orientado por formador, que indicam quanta experiência na função é necessária para compreender todos os aspetos deste curso. Os detalhes sobre as unidades podem ser referenciados nos registos de níveis. |
study_guide |
matriz de objetos | Um URL completamente qualificado para o PDF que descreve as competências medidas por esta certificação. |
Registos de níveis, produtos, funções e assuntos
As coleções levels, products, roles e subjects fornecem nomes amigáveis para os valores utilizados nos dados do módulo e do percurso de aprendizagem. As quatro coleções têm a mesma forma:
{
"id": "unique-id",
"name": "name-of-item",
"children": [
{ "id": "unique-id", "name": "name-of-item" },
{ "id": "unique-id", "name": "name-of-item" },
...
]
}
O valor id corresponderá aos níveis, produtos, funções e assuntos incluídos nas outras entradas do catálogo. O name associado fornece um nome adequado em inglês para a entrada. A matriz children é opcional e permite uma hierarquia de valores que têm relações subordinadas, tais como produtos.
Como exemplo, veja um conjunto de funções possíveis:
{
...
"roles": [
{
"id": "administrator",
"name": "Administrator"
},
{
"id": "ai-engineer",
"name": "AI Engineer"
},
{
"id": "business-analyst",
"name": "Business Analyst"
},
{
"id": "developer",
"name": "Developer"
},
...
]
}
Veja um conjunto de exemplo de produtos, com elementos subordinados incluídos para fornecer uma categoria de produto mais específica.
{
...
"products": [
{
"id": "dotnet",
"name": ".NET",
"children": [
{ "id": "dotnet-core", "name": ".NET Core" },
{ "id": "dotnet-standard", "name": ".NET Standard" },
{ "id": "aspnet-core", "name": "ASP.NET Core" },
{ "id": "ef-core", "name": "Entity Framework Core" }
]
},
{
"id": "ms-graph",
"name": "Microsoft Graph"
},
{
"id": "office",
"name": "Office",
"children": [
{ "id": "office-365", "name": "Office 365" },
{ "id": "office-add-ins", "name": "Office Add-ins" },
{ "id": "office-teams", "name": "Teams" }
]
},
{
"id": "sql-server",
"name": "SQL Server"
},
...
]
}
Amostras de código
Há várias formas de chamar a API de Catálogo do Learn, mas seguem-se exemplos de código de como pode ser utilizada.
jQuery
$(function() {
var params = {
locale:'en-us'
};
$.ajax({
url: "https://learn.microsoft.com/api/learn/catalog?" + $.param(params),
type: "GET"
}).done(function(data) {
alert("success");
}).fail(function(error) {
alert("error");
});
})
.NET e C#
public string GetCatalogData()
{
var client = new WebClient();
client.Headers.Add(HttpRequestHeader.UserAgent, "Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; rv:11.0) like Gecko");
var response = client.DownloadString("https://learn.microsoft.com/api/learn/catalog?locale=en-us");
dynamic parsedJson = JsonConvert.DeserializeObject(response);
JsonConvert.SerializeObject(response, Formatting.Indented);
return Convert.ToString(response);
}
PHP com a extensão cURL
<?php
// From URL to get webpage contents.
$url = "https://learn.microsoft.com/api/learn/catalog";
// Initialize a CURL session.
$ch = curl_init();
// Return Page contents.
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
//grab URL and pass it to the variable.
curl_setopt($ch, CURLOPT_URL, $url);
$result = curl_exec($ch);
echo $result;
?>
PYTHON 3 com a biblioteca "requests"
#!/usr/bin/env python3
#Using Python 3.8.2 install 5/6/2020
import requests
import json
#if given error 'response / requests not defined', install requests via 'pip install requests' in the command line
parameters= {"locale": "en-us"}
response = requests.get("https://learn.microsoft.com/api/learn/catalog/", parameters)
#print(response.status_code)
rawJson = response._content
#Create python objects based on the data using json.loads
data = json.loads(rawJson)
print(data)
Próximos passos
Analise os recursos abaixo para ajudá-lo em sua jornada de desenvolvimento: