Documentação de referência para desenvolvedores da API de Catálogo do Microsoft Learn
Este artigo fornece informações para desenvolvedores e solicitantes que implementam a API de Catálogo do Microsoft Learn. Também recomendamos conferir os artigos sobre melhores práticas, notas sobre a versão e perguntas frequentes da API de Catálogo do Learn para dar suporte ao seu percurso de desenvolvimento.
Ponto de extremidade de API
A API de Catálogo do Microsoft Learn é 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/
Observação
O ponto de extremidade listado acima é o ponto de extremidade atual. Se você estiver usando um ponto de extremidade diferente e mais antigo ainda funcionará conforme você esperava quando fez a integração, mas os benefícios de migrar para o novo ponto de extremidade são os recursos aprimorados, como parâmetros de consulta adicionais.
Parâmetros de consulta
Veja a seguir os parâmetros de consulta que a solicitação pode incluir. Todos são opcionais. Codifique em URL os valores do parâmetro de consulta. Você pode usar o ponto de extremidade com nenhum, um, alguns ou todos esses parâmetros.
Importante
Se você usar mais de um, a consulta será avaliada usando o operador AND.
| Nome | Valor | Tipo | Necessária | Exemplo |
|---|---|---|---|---|
| localidade | Um código de localidade único válido da lista de localidades com suporte. Os metadados retornados estarão na localidade solicitada, se disponível. Se esse parâmetro não for fornecido, a resposta en-us será retornada. |
string | Não | ?locale=en-us |
| type | 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 ser retornada. Os valores com suporte são: modules, units, learningPaths, appliedSkills, certifications, mergedCertifications, exams, courses, levels, roles, products e subjects. |
string | No | ?type=modules,learningPaths |
| uid | Uma lista separada por vírgulas de uma ou mais IDs exclusivas de conteúdo (uid) válidas dos tipos de conteúdo disponíveis. Observação: as UIDs diferenciam maiúsculas de minúsculas. | string | Não | ?uid=learn.azure.intro-to-azure-fundamentals |
| last_modified | Um operador e datetime a serem filtrados pela última data modificada 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 você usar esse parâmetro, o operador usará como padrão gte se não for especificado. |
string | No | ?last_modified=gte 2022-01-01 |
| popularity | Um operador e um valor a serem filtrados pelo valor de popularidade (em um 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 você usar esse parâmetro, o operador usará como padrã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 à 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 à API). | string | No | ?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 à API). A API não dá suporte à hierarquia de produtos. Portanto, adicione todos os produtos à lista que você deseja incluir em sua consulta. | string | No | ?product=azure |
| subject | 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 à API). A API não dá suporte à hierarquia de assuntos. Portanto, adicione todos os assuntos à lista que você deseja incluir em sua consulta. | string | No | ?subject=cloud-computing |
Consultas de exemplo
As consultas listadas abaixo são exemplos para ajudar você a ter uma noção do que pode solicitar e como formar a solicitação.
| Descrição | Consulta |
|---|---|
| Todos os itens na API de catálogo do Learn | https://learn.microsoft.com/api/catalog/ |
| Todos os módulos espanhóis | https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules |
| Todos os módulos com uma pontuação de popularidade igual ou superior a 0,9 | https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9 |
| Todos os objetos de treinamento e certificação de segurança para iniciantes | https://learn.microsoft.com/api/catalog/?level=beginner&subject=security |
| Todos os módulos avançados de acessibilidade com uma pontuaçã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 retornar os códigos de status HTTP a seguir.
| Código de status | Descrição |
|---|---|
| 200 | Êxito. O corpo da resposta inclui os dados codificados em JSON. |
| 400 | Um dos parâmetros de consulta está ausente ou não é válido. |
| 404 | A URL não foi encontrada no servidor. |
| 500 | Erro de servidor inesperado. |
| 503 | O serviço está temporariamente indisponível. |
Uma resposta bem-sucedida incluirá detalhes sobre todos os módulos e roteiros de aprendizagem, conforme mostrado 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 contendo dados específicos dessa seção da resposta.
modules: é uma matriz de módulos publicados.units: é uma matriz de unidades publicadas.learningPaths: é uma matriz de roteiros de aprendizagem publicados.appliedSkills: é uma matriz de habilidades aplicadas publicadas.mergedCertifications: é uma matriz 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 treinamento com instrutor publicados.levels: é uma matriz de possíveis níveis de público-alvo.products: é uma matriz de produtos e serviços possíveis abrangidos no catálogo.roles: é uma matriz de possíveis funções de trabalho.subjects: é uma matriz de possíveis marcas de assunto.
Registros de módulo
Registros de módulo
Cada registro 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 | Type | Descrição |
|---|---|---|
summary |
Cadeia de caracteres | Uma cadeia de caracteres que fornece uma breve descrição do módulo. O valor é expresso como uma marca de parágrafo HTML com o texto interno sendo o resumo. |
levels |
Matriz de cadeias de caracteres | Uma lista dos níveis associados a esse módulo, que indicam quanta experiência na função é necessária para entender todos os seus aspectos. Os detalhes sobre as unidades podem ser referenciados nos registros de nível. |
roles |
Matriz de cadeias de caracteres | Uma lista das funções de trabalho para as quais o módulo é relevante. |
products |
Matriz de cadeias de caracteres | Uma lista de produtos relevantes que o módulo aborda. Os detalhes sobre os produtos podem ser referenciados nos registros do produto. |
subjects |
Matriz de cadeias de caracteres | Uma lista de assuntos relevantes que o roteiro de aprendizagem aborda. |
uid |
Cadeia de caracteres | Um identificador exclusivo do módulo – esse valor será exclusivo em todo o MS Learn. |
type |
Cadeia de caracteres | O tipo de registro. O valor será sempre "module". |
title |
Cadeia de caracteres | O título do módulo na localidade solicitada ou inglês americano como um fallback. |
duration_in_minutes |
Número inteiro | O tempo médio que o módulo leva para ser concluído em minutos. |
rating |
objeto | Contém o 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 |
double | Um valor normalizado de 0 a 1 indicando a popularidade do módulo |
icon_url |
Cadeia de caracteres | Uma URL totalmente qualificada para uma imagem SVG 100 x 100 que representa a imagem de conquista do módulo com uma tela de fundo transparente. |
social_image_url |
string | Uma URL totalmente qualificada para uma imagem PNG que representa a imagem de conquista do módulo com uma tela de fundo opaco retangular, adequado para experiências de mídia social ou de bloco. Se não estiver disponível para este módulo, essa propriedade não será retornada na resposta. |
locale |
Cadeia de caracteres | O idioma em que os dados JSON são gravados. Esse valor será a localidade solicitada, se disponível, ou "en-us", se não. |
last_modified |
Data | A última vez em que o módulo teve uma revisão completa. |
url |
Cadeia de caracteres | Uma URL totalmente qualificada para o módulo do Learn na localidade solicitada. |
firstUnitUrl |
string | Uma URL totalmente qualificada para a primeira unidade do módulo do Learn na localidade solicitada. |
units |
Matriz de cadeias de caracteres | Uma lista das UIDs de unidade associadas. Os detalhes sobre as unidades podem ser referenciados nos registros de unidade. |
number_of_children |
Número inteiro | O número de páginas (unidades) do módulo. |
Registros de unidade
Cada registro 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"
},
Observação
O registro de unidade não tem a URL associada porque as unidades não são escritas como conteúdo autônomo. Ele deve ser obtido 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 no registro de módulo para que os usuários possam começar lá e prosseguir com o conteúdo. No entanto, os registros de unidade podem ser usados para obter detalhes sobre as unidades a serem exibidas em LMSs ou outras experiências.
Detalhes do campo
| Campo | Type | Descrição |
|---|---|---|
uid |
Cadeia de caracteres | Um identificador exclusivo do módulo – esse valor será exclusivo em todo o MS Learn. |
type |
Cadeia de caracteres | O tipo de registro. O valor será sempre "unit". |
title |
string | O título da unidade na localidade solicitada ou em inglês dos EUA como um fallback. |
duration_in_minutes |
A duração da unidade. Se você somar todos os duration_in_minutes das unidades associadas a cada módulo, vai obter o tempo total do módulo. | |
locale |
Cadeia de caracteres | O idioma em que os dados JSON são gravados. Esse valor será a localidade solicitada, se disponível, ou "en-us", se não. |
last_modified |
Data | A última vez em que o módulo teve uma revisão completa. |
Registros de roteiros de aprendizagem
Cada registro de roteiro 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 | Type | Descrição |
|---|---|---|
summary |
Cadeia de caracteres | Uma cadeia de caracteres que fornece uma breve descrição do roteiro de aprendizagem. O valor é expresso como uma marca de parágrafo HTML com o texto interno sendo o resumo. |
levels |
Matriz de cadeias de caracteres | Uma lista dos níveis associados a esse roteiro de aprendizagem, que indicam quanta experiência na função é necessária para entender todos os seus aspectos. Os detalhes sobre as unidades podem ser referenciados nos registros de nível. |
roles |
Matriz de cadeias de caracteres | Uma lista das funções de trabalho relevantes para o roteiro de aprendizagem. |
products |
Matriz de cadeias de caracteres | Uma lista de produtos relevantes que o roteiro de aprendizagem aborda. Os detalhes sobre os produtos podem ser referenciados nos registros do produto. |
subjects |
Matriz de cadeias de caracteres | Uma lista de assuntos relevantes que o roteiro de aprendizagem aborda. |
uid |
Cadeia de caracteres | Um identificador exclusivo do roteiro de aprendizagem – esse valor será exclusivo em todo o MS Learn. |
type |
Cadeia de caracteres | O tipo de registro. O valor será sempre "learningPath". |
title |
Cadeia de caracteres | O título do roteiro de aprendizagem na localidade solicitada ou inglês americano como um fallback. |
duration_in_minutes |
Número inteiro | O tempo médio que o roteiro de aprendizagem leva para ser concluído em minutos. Esse valor é uma soma dos dados de todos os módulos incluídos. |
rating |
objeto | Contém o count, que é o número de pessoas que classificaram o roteiro de aprendizagem, e average, uma agregação das classificações, que será de 1 a 5 |
popularity |
double | Um valor normalizado de 0 a 1 indicando a popularidade do roteiro de aprendizagem |
icon_url |
Cadeia de caracteres | Uma URL totalmente qualificada para uma imagem SVG 100 x 100 que representa o roteiro de aprendizagem. |
social_image_url |
string | Uma URL totalmente qualificada para uma imagem PNG que representa a imagem de conquista do roteiro de aprendizagem com uma tela de fundo opaco retangular, adequado para experiências de mídia social ou de bloco. Se não estiver disponível para este módulo, essa propriedade não será retornada na resposta. |
locale |
Cadeia de caracteres | O idioma em que os dados JSON são gravados. Esse valor será a localidade solicitada, se disponível, ou "en-us", se não. |
last_modified |
Data | A última vez em que o roteiro de aprendizagem foi alterado. |
url |
Cadeia de caracteres | Uma URL totalmente qualificada para o roteiro de aprendizagem no Microsoft Learn na localidade solicitada. |
firstModuleUrl |
string | Uma URL totalmente qualificada para o primeiro módulo do roteiro de aprendizagem no Microsoft Learn na localidade solicitada. |
modules |
Matriz de cadeias de caracteres | Uma lista das UIDs do módulo associadas. Os detalhes sobre os módulos podem ser referenciados nos registros de módulo. |
number_of_children |
Número inteiro | O número de módulos do roteiro de aprendizagem. |
Registros de Habilidades Aplicadas
Cada registro de habilidades aplicadas terá o seguinte formulário:
{
"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 | Type | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para essa habilidade aplicada – esse valor será exclusivo em todo o Microsoft Learn. |
locale |
string | O idioma em que os dados JSON são gravados. Esse valor será a localidade solicitada, se disponível, ou "en-us", se não. |
title |
string | O título da habilidade aplicada na localidade solicitada, ou em inglês dos EUA como alternativa. |
summary |
string | O resumo da habilidade aplicada na localidade solicitada, ou em inglês dos EUA como alternativa. |
url |
string | Uma URL totalmente qualificada para a habilidade aplicada do Microsoft Learn na localidade solicitada. |
icon_url |
string | Uma URL totalmente qualificada para uma imagem SVG 100x100 que representa a habilidade aplicada (quando disponível, caso contrário, não incluída). |
levels |
matriz de cadeias de caracteres | Uma lista dos níveis associados a essa Applied Skill. |
roles |
matriz de cadeias de caracteres | Uma lista das funções de trabalho relevantes para essa Applied Skill. Os detalhes sobre as funções podem ser referenciados nos registros de função. |
subjects |
Matriz de cadeias de caracteres | Uma lista de assuntos relevantes que essa Applied Skill abrange. |
study_guide |
matriz de objetos | Uma lista do conteúdo associado a ser estudado para essa Applied Skill. Os detalhes sobre os objetos podem ser referenciados em seus registros associados. |
last_modified |
date | A última vez que essa Applied Skill 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 | Type | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para esta certificação. Esse valor será exclusivo em todo o MS Learn. |
title |
string | O título da certificação na localidade solicitada ou em inglês dos EUA como um fallback. |
summary |
string | O resumo da certificação na localidade solicitada, ou em inglês dos EUA como alternativa. |
url |
string | Uma URL totalmente qualificada para a certificação no Microsoft Learn na localidade solicitada. |
icon_url |
string | Uma URL totalmente qualificada para uma imagem SVG 100 x 100 que representa a certificação. |
last_modified |
date | A última vez que essa certificação foi alterada. |
type |
string | O tipo de registro. 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 de caracteres | Uma lista de produtos relevantes que essa certificação abrange. Os detalhes sobre os produtos podem ser referenciados nos registros do produto. |
levels |
Matriz de cadeias de caracteres | Uma lista dos níveis associados a essa certificação, que indicam quanta experiência na função é necessária para entender todos os aspectos dos exames da certificação. Os detalhes sobre as unidades podem ser referenciados nos registros de nível. |
roles |
Matriz de cadeias de caracteres | Uma lista das funções de trabalho relevantes para essa certificação. Os detalhes sobre as funções podem ser referenciados nos registros de função. |
subjects |
Matriz de cadeias de caracteres | Uma lista de assuntos relevantes que essa certificação abrange. |
renewal_frequency_in_days |
Número inteiro | O número de dias antes dessa certificação expirar e precisar ser renovado. Se o valor for 0, a certificação não expirará. |
prerequisites |
matriz de cadeias de caracteres | Uma lista dos pré-requisitos recomendados para obter essa certificação. Detalhes sobre as certificações podem ser referenciados nos registros de certificação. |
skills |
matriz de cadeias de caracteres | Uma lista das habilidades medidas no exame necessário para essa certificação. |
recommendation_list |
matriz de cadeias de caracteres | Uma lista dos itens recomendados relacionados a essa certificação. |
study_guide |
matriz de objetos | Uma lista dos conteúdos associados a serem estudados para essa certificação. Os detalhes sobre os objetos podem ser referenciados em seus registros associados. |
exam_duration_in_minutes |
Número inteiro | O número de minutos alocados para concluir o exame. |
locales |
matriz de cadeias de caracteres | Uma lista dos idiomas em que essa certificação é oferecida. |
providers |
matriz de objetos | Uma lista de provedores para essa certificação. O tipo descreve qual provedor e uma URL totalmente qualificada com um link para agendamento de um exame com o provedor. |
career_paths |
matriz de objetos | Uma lista de caminhos de carreira para essa certificação. |
Observação
As certificações que exigem apenas um exame serão retornadas como parte dessa propriedade mergedCertifications.
Registros de certificação
Cada registro 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 | Type | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para esta certificação. Esse valor será exclusivo em todo o MS Learn. |
title |
string | O título da certificação na localidade solicitada ou em inglês dos EUA como um fallback. |
subtitle |
string | O subtítulo da certificação na localidade solicitada ou em inglês dos EUA como um fallback. |
url |
string | Uma URL totalmente qualificada para a certificação no Microsoft Learn na localidade solicitada. |
icon_url |
string | Uma URL totalmente qualificada para uma imagem SVG 100 x 100 que representa a certificação. |
type |
Cadeia de caracteres | O tipo de registro. 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 de caracteres | Uma lista dos exames associados necessários para essa certificação. Os detalhes sobre as unidades podem ser referenciados nos registros de certificação. |
levels |
Matriz de cadeias de caracteres | Uma lista dos níveis associados a essa certificação, que indicam quanta experiência na função é necessária para entender todos os aspectos dos exames da certificação. Os detalhes sobre as unidades podem ser referenciados nos registros de nível. |
roles |
Matriz de cadeias de caracteres | Uma lista das funções de trabalho relevantes para essa certificação. Os detalhes sobre as funções podem ser referenciados nos registros de função. |
study_guide |
matriz de objetos | Uma lista dos conteúdos associados a serem estudados para essa certificação. Os detalhes sobre os objetos podem ser referenciados em seus registros associados. |
Observação
As certificações que exigem mais de um exame estarão presentes neste registro de Certificações referenciando a matriz de exames.
Registros de exame
Cada registro 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 | Type | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para esse exame – o valor será exclusivo em todo o MS Learn. |
title |
string | O título do exame na localidade solicitada ou em inglês dos EUA como um fallback. |
subtitle |
string | O subtítulo do exame na localidade solicitada ou em inglês dos EUA como um fallback. |
display_name |
string | O nome de exibição do exame na localidade solicitada ou em inglês dos EUA como um fallback. |
url |
string | Uma URL totalmente qualificada para o exame no Microsoft Learn na localidade solicitada. |
icon_url |
string | Uma URL totalmente qualificada para uma imagem SVG 100 x 100 que representa o exame. |
pdf_download_url |
string | Uma URL totalmente qualificada para o PDF que descreve as habilidades medidas por esse exame. |
practice_test_url |
string | Uma URL totalmente qualificada para um teste de prática associado ao exame. |
practice_assessment_url |
string | Uma URL totalmente qualificada para uma avaliação gratuita de prática associada ao exame. |
locales |
Matriz de cadeias de caracteres | Uma lista de idiomas em que esse exame é oferecido. |
type |
Cadeia de caracteres | O tipo de registro. O valor será sempre "exam". |
courses |
Matriz de cadeias de caracteres | Uma lista das UIDs de curso associadas. Os detalhes sobre os cursos podem ser referenciados nos registros de curso. |
levels |
Matriz de cadeias de caracteres | Uma lista dos níveis associados a esse exame, que indicam quanta experiência na função é necessária para entender todos os seus aspectos. Os detalhes sobre as unidades podem ser referenciados nos registros de nível. |
roles |
Matriz de cadeias de caracteres | Uma lista das funções de trabalho relevantes para esse exame. Os detalhes sobre as funções podem ser referenciados nos registros de função. |
products |
Matriz de cadeias de caracteres | Uma lista dos produtos relevantes que são abrangidos por esse exame. Os detalhes sobre os produtos podem ser referenciados nos registros do produto. |
providers |
matriz de objetos | Uma lista de provedores para esse exame. O tipo descreve qual provedor e uma URL totalmente qualificada com um link para agendamento de um exame com o provedor. |
study_guide |
matriz de objetos | Uma lista dos conteúdos associados a serem estudados para esse exame. Os detalhes sobre os objetos podem ser referenciados em seus registros associados. |
Registros de curso com instrutor
Cada registro 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 | Type | Descrição |
|---|---|---|
uid |
string | Um identificador exclusivo para esse curso com instrutor – esse valor será exclusivo em todo o MS Learn. |
course_number |
string | O identificador de número do curso com instrutor. |
title |
string | O título do curso com instrutor na localidade solicitada ou em inglês dos EUA como um fallback. |
summary |
string | Uma cadeia de caracteres que fornece uma breve descrição do curso com instrutor. O valor é expresso como uma marca de parágrafo HTML com o texto interno sendo o resumo. |
duration_in_hours |
Número inteiro | O tempo médio que o curso com instrutor leva para ser concluído em horas. |
url |
string | Uma URL totalmente qualificada para a página de detalhes do curso com instrutor no Microsoft Learn na localidade solicitada. |
icon_url |
string | Uma URL totalmente qualificada para uma imagem SVG 100 x 100 que representa a conquista do curso com instrutor. |
locales |
Matriz de cadeias de caracteres | Uma lista de idiomas em que esse curso com instrutor é oficialmente oferecido. Pode haver outros idiomas para os quais haja suporte por parceiros de aprendizagem. |
type |
Cadeia de caracteres | O tipo de registro. O valor sempre será “course” para cursos com instrutor. |
certification |
string | Certificação associada ao curso com instrutor. |
exam |
string | Exame associado ao curso com instrutor. |
levels |
Matriz de cadeias de caracteres | Uma lista dos níveis associados a esse curso com instrutor, que indicam quanta experiência na função é necessária para entender todos os seus aspectos. Os detalhes sobre as unidades podem ser referenciados nos registros de nível. |
study_guide |
matriz de objetos | Uma URL totalmente qualificada para o PDF que descreve as habilidades medidas por essa certificação. |
Nível, produto, função e registros de assunto
As coleções levels, products, roles e subjects fornecem nomes amigáveis para os valores usados nos dados do módulo e do roteiro de aprendizagem. Todas as três 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" },
...
]
}
id corresponderá aos valores de níveis, 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 habilita a hierarquia de valores que têm relações de filho, como produtos.
Como exemplo, confira 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 exemplos de produtos, com filhos 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"
},
...
]
}
Exemplos de código
Há várias maneiras de chamar a API de catálogo do Learn, mas os exemplos de código abaixo são exemplos de como ela pode ser usada.
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 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 usando 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 usando 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óximas etapas
Examine os recursos abaixo para ajudar você em seu percurso de desenvolvimento: