Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Artikel ini membantu Anda memulai menggunakan Microsoft Learn Platform API. Jika Anda tidak terbiasa dengan detail API atau kasus penggunaan untuk itu, kami sarankan Anda meninjau artikel Gambaran Umum API Platform Microsoft Learn terlebih dahulu.
Pelajari Tentang Autentikasi API Platform
API REST Platform Learn menggunakan ID Microsoft Entra untuk autentikasi. Sebelum melakukan panggilan API, Anda perlu memilih metode akses, dan aplikasi klien Anda harus mengautentikasi dengan kredensial yang valid.
Akses khusus aplikasi
Saat aplikasi Anda langsung mengakses Learn, aksesnya tidak terkait dengan satu pengguna pun. Aplikasi memanggil API secara langsung menggunakan identitasnya sendiri, skenario ini adalah akses khusus aplikasi. Pelajari selengkapnya di platform identitas Microsoft.
Untuk memulai, Anda memerlukan identitas yang valid di Platform Identitas Microsoft, yang dapat menjadi pendaftaran aplikasi atau identitas terkelola. Idealnya, setiap mitra harus memiliki satu identitas untuk menyederhanakan kuota dan manajemen mitra. Menggunakan identitas terkelola yang ditetapkan pengguna dapat membantu menyatukan identitas terkelola di berbagai layanan.
Setelah identitas ID Entra Anda disiapkan, dapatkan token akses dari ID Entra dengan cakupan yang diatur ke https://learn.microsoft.com/.default sebagai bukti autentikasi. Sertakan token akses di header Otorisasi HTTP saat membuat permintaan REST API ke Learn.
Akses didelegasikan
Saat pengguna masuk ke aplikasi Anda dan menggunakannya untuk mengakses Learn, aplikasi harus terlebih dahulu meminta izin untuk mengakses sumber daya ini atas nama pengguna. Skenario ini disebut akses yang didelegasikan. Pelajari selengkapnya di platform identitas Microsoft.
Untuk memulai, Anda perlu mendaftarkan pendaftaran aplikasi. Setelah pendaftaran aplikasi Anda disiapkan, aplikasi Anda perlu meminta pengguna untuk memberikan cakupan tertentu, atau serangkaian cakupan untuk mengakses Learn atas nama pengguna. Learn menyediakan daftar cakupan untuk akses sumber daya yang halus. Daftar cakupan meliputi:
-
https://learn.microsoft.com/PublicContent.Read.All: Cakupan ini memungkinkan pengguna untuk mengakses konten publik di Learn yang dipersonifikasikan sebagai pengguna yang masuk.
Memahami Penerapan Versi API Platform Microsoft Learn
Ketika perubahan besar dilakukan pada API, kami merilis versi baru dengan tanggal rilis terbaru. Perubahan yang dapat merusak adalah perubahan yang berpotensi memutus integrasi. Setiap perubahan yang tidak melanggar (aditif) akan tersedia di semua versi API yang didukung.
Versi API ditentukan sebagai parameter kueri versi api dan menggunakan yyyy-MM-dd untuk versi stabil dan yyyy-MM-dd-preview untuk versi pratinjau. Parameter kueri versi api diperlukan untuk setiap permintaan API.
Saat versi API stabil baru dirilis, versi API stabil sebelumnya didukung setidaknya selama 24 bulan lagi setelah rilis versi API baru. API pratinjau memiliki siklus dukungan yang lebih pendek yaitu hanya tiga bulan setelah rilis API pratinjau baru.
Versi saat ini adalah 2023-11-01-preview.
Segmen URL /v1/ sebelum setiap API adalah bagian dari URL dasar bukan versi API. Ini dicadangkan untuk perubahan protokol dan pola API yang substansial di masa depan.
Pelajari Pembatasan Laju API Platform
Learn membatasi jumlah permintaan REST API yang dapat Anda buat dalam jumlah waktu tertentu. Batas ini membantu mencegah penyalahgunaan dan penolakan serangan layanan, dan memastikan bahwa API tetap tersedia untuk semua pengguna.
Learn menerapkan batas tarif berdasarkan klaim oid dalam token akses. Untuk akses khusus aplikasi, batas diterapkan ke aplikasi itu sendiri, sementara untuk akses yang didelegasikan, batas diterapkan ke pengguna yang masuk ke aplikasi.
Secara default, batas tarif adalah 100 panggilan API per menit, dihitung selama jendela 5 menit. Jika Anda memerlukan batas yang lebih tinggi untuk produksi, Anda dapat menghubungi Dukungan Integrasi Learn untuk meminta peningkatan.
API tertentu, seperti API pencarian pengetahuan, juga menerapkan pembatasan tarif berbasis token. Ini didasarkan pada jumlah token Microsoft Azure OpenAI yang digunakan, dengan batas default 10.000 token per menit. Untuk meningkatkan batas produksi ini, hubungi Dukungan Pelajari Integrasi.
Learn Platform API Pagination
Semua sumber daya API tingkat atas mendukung pengambilan massal melalui metode API 'list'. Misalnya, Anda dapat mengambil daftar modul atau ujian. Metode ini mengembalikan respons yang dipaginasi mengikuti pendekatan standar.
Metode API daftar menggunakan penomoran halaman berbasis kursor, yang ditunjukkan oleh bidang nextLink dalam isi respons. Bidang ini berisi URL buram dengan informasi yang diperlukan untuk mengambil halaman hasil berikutnya. Secara default, DAFTAR API mengembalikan 30 item per permintaan, tetapi Anda dapat menyesuaikan ukuran halaman menggunakan parameter maxpagesize.
Perpustakaan SDK klien kami menawarkan fitur autopaginasi untuk menjelajahi semua halaman dari daftar.