เอกสารอ้างอิงสําหรับนักพัฒนาแค็ตตาล็อก MICROSOFT Learn Catalog API

บทความนี้ให้ข้อมูลสําหรับนักพัฒนาและผู้ร้องขอที่ใช้ แค็ตตาล็อก API Microsoft Learn นอกจากนี้เราขอแนะนําให้ตรวจสอบ LEARN Catalog API แนวทางปฏิบัติที่ดีที่สุดบันทึกย่อประจํารุ่น และ คําถามที่ถามบ่อย บทความเพื่อสนับสนุนการเดินทางเพื่อการพัฒนาของคุณ

จุดสิ้นสุด API

แค็ตตาล็อก API Microsoft Learn เป็นเว็บ API ที่ใช้ REST ซึ่งส่งกลับการตอบสนองที่เข้ารหัส JSON หากต้องการร้องขอแค็ตตาล็อกแบบเต็ม ให้ส่งคําขอ GET ไปยัง:

https://learn.microsoft.com/api/catalog/

พารามิเตอร์คิวรี

ต่อไปนี้คือพารามิเตอร์คิวรีที่คําขอสามารถรวมได้ ทั้งหมดเป็นทางเลือก คุณต้องเข้ารหัส URL ค่าพารามิเตอร์คิวรี คุณสามารถใช้จุดสิ้นสุดกับไม่มี หนึ่ง บางส่วน หรือทั้งหมดของพารามิเตอร์เหล่านี้ได้

คิวรีตัวอย่าง

คิวรีที่แสดงด้านล่างเป็นตัวอย่างเพื่อช่วยให้คุณเข้าใจถึงสิ่งที่คุณสามารถร้องขอได้และวิธีสร้างคําขอ

การตอบสนอง API

บริการอาจแสดงเป็นรหัสสถานะ HTTP ต่อไปนี้

การตอบสนองที่สําเร็จจะมีรายละเอียดเกี่ยวกับโมดูลและเส้นทางการเรียนรู้ทั้งหมด ดังที่แสดงด้านล่าง

ร่างกายตอบสนอง

เนื้อหาคําตอบที่สําเร็จจะถูกเข้ารหัสใน JSON และมี 12 ส่วน:

{
    "modules": [ ... ],
    "units": [...],
    "learningPaths": [ ... ],
    "appliedSkills": [ ... ],
    "mergedCertifications": [ ... ],
    "certifications": [ ... ],
    "exams": [ ... ],
    "courses": [ ... ],
    "levels": [ ... ],
    "products": [ ... ],
    "roles": [ ... ],
    "subjects": [...],
}

แต่ละอาร์เรย์มีอย่างน้อยหนึ่งวัตถุที่เข้ารหัส JSON ที่ประกอบด้วยข้อมูลที่ระบุเฉพาะในส่วนของการตอบสนอง

1. modules: คืออาร์เรย์ของโมดูลที่เผยแพร่
2. units: เป็นอาร์เรย์ของหน่วยที่เผยแพร่
3. learningPaths: เป็นอาร์เรย์ของเส้นทางการเรียนรู้ที่เผยแพร่แล้ว
4. appliedSkills: คือการเรียงลําดับของทักษะประยุกต์ที่เผยแพร่
5. mergedCertifications: เป็นอาร์เรย์ของใบรับรองที่เผยแพร่ที่ผสานกับการสอบ
6. certifications: เป็นอาร์เรย์ของใบรับรองที่เผยแพร่แล้ว
7. exams: เป็นอาร์เรย์ของการสอบที่เผยแพร่แล้ว
8. courses: เป็นอาร์เรย์ของหลักสูตรการฝึกอบรมที่นําโดยผู้สอนที่เผยแพร่แล้ว
9. levels: คือการเรียงลําดับระดับผู้ชมที่เป็นไปได้
10. products: เป็นอาร์เรย์ของผลิตภัณฑ์และบริการที่เป็นไปได้ที่ครอบคลุมในแคตตาล็อก
11. roles: คืออาร์เรย์ของบทบาทงานที่เป็นไปได้
12. subjects: เป็นอาร์เรย์ของแท็กชื่อเรื่องที่เป็นไปได้

เรกคอร์ดโมดูล

เรกคอร์ดโมดูล

แต่ละเรกคอร์ดของโมดูลจะมีฟอร์มต่อไปนี้:

{
    "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
}

รายละเอียดเขตข้อมูล

เรกคอร์ดหน่วย

แต่ละเรกคอร์ดหน่วยจะมีฟอร์มต่อไปนี้:

{
    "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"
},

รายละเอียดเขตข้อมูล

การบันทึกเส้นทางการเรียนรู้

แต่ละบันทึกเส้นทางการเรียนรู้จะมีฟอร์มต่อไปนี้:

{
    "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
}

รายละเอียดเขตข้อมูล

ระเบียนทักษะที่นําไปใช้

แต่ละระเบียนทักษะที่ใช้จะมีฟอร์มต่อไปนี้:

{
    "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"
}

รายละเอียดเขตข้อมูล

ผสานระเบียนใบรับรองแล้ว

เรกคอร์ดใบรับรองที่ผสานกันแต่ละรายการจะมีฟอร์มต่อไปนี้:

{
    "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": []
}

รายละเอียดเขตข้อมูล

บันทึกใบรับรอง

บันทึกใบรับรองแต่ละรายการจะมีฟอร์มต่อไปนี้:

{
    "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"
        }
    ]
}

รายละเอียดเขตข้อมูล

บันทึกการสอบ

แต่ละระเบียนการสอบจะมีฟอร์มต่อไปนี้:

{
    "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"
        }
    ]
}

รายละเอียดเขตข้อมูล

เรกคอร์ดหลักสูตรที่นําโดยผู้สอน

แต่ละเรกคอร์ดหลักสูตรจะมีฟอร์มต่อไปนี้:

{
    "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"
        }
    ]
},

รายละเอียดเขตข้อมูล

ระเบียนระดับ ผลิตภัณฑ์ บทบาท และชื่อเรื่อง

คอลเลกชัน levels, products, rolesและ subjects มีชื่อที่เรียกง่ายสําหรับค่าที่ใช้ในข้อมูลโมดูลและเส้นทางการเรียนรู้ คอลเลกชันทั้งสี่มีรูปร่างเหมือนกัน:

{
    "id": "unique-id",
    "name": "name-of-item",
    "children": [
        { "id": "unique-id", "name": "name-of-item" },
        { "id": "unique-id", "name": "name-of-item" },
           ...
    ]
}

id จะตรงกับค่าสําหรับระดับ ผลิตภัณฑ์ บทบาท และหัวเรื่องที่รวมอยู่ในรายการแค็ตตาล็อกอื่น ๆ name ที่เกี่ยวข้องแสดงชื่อที่เหมาะสมในภาษาอังกฤษสําหรับรายการ อาร์เรย์ children เป็นตัวเลือกและลําดับชั้นที่เปิดใช้งานสําหรับค่าที่มีความสัมพันธ์ย่อย เช่น ผลิตภัณฑ์

ตัวอย่างเช่น นี่คือชุดของบทบาทที่เป็นไปได้:

{
    ...
    "roles": [
        {
            "id": "administrator",
            "name": "Administrator"
        },
        {
            "id": "ai-engineer",
            "name": "AI Engineer"
        },
        {
            "id": "business-analyst",
            "name": "Business Analyst"
        },
        {
            "id": "developer",
            "name": "Developer"
        },
        ...
    ]
}

ต่อไปนี้คือชุดตัวอย่างของผลิตภัณฑ์ที่มีเด็กรวมอยู่ในการให้ข้อมูลประเภทผลิตภัณฑ์ที่เฉพาะเจาะจงมากขึ้น

{
    ...
    "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"
        },
        ...
    ]
}

ตัวอย่างโค้ด

มีหลายวิธีในการเรียกใช้ API แค็ตตาล็อก Learn แต่ตัวอย่างโค้ดด้านล่างเป็นตัวอย่างของวิธีที่สามารถใช้

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 ที่ใช้ส่วนขยาย 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 โดยใช้ไลบรารี 'คําขอ'

#!/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)

ขั้นตอนถัดไป

ตรวจทานแหล่งข้อมูลด้านล่างเพื่อช่วยให้คุณในการเดินทางการพัฒนาของคุณ:

• แนวทางปฏิบัติที่ดีที่สุดสําหรับแค็ตตาล็อก API Learn
• คําถามที่ถามบ่อยเกี่ยวกับแค็ตตาล็อก API Learn
• บันทึกการวางจําหน่ายแค็ตตาล็อก API Learn