Microsoft Learn Platform API'sini kullanmaya başlama

Bu makale, Microsoft Learn Platform API'sini kullanmaya başlamanıza yardımcı olabilir. API'nin ayrıntılarını veya kullanım örneklerini bilmiyorsanız, önce Microsoft Learn Platform API'sine Genel Bakış makalesini gözden geçirmenizi öneririz.

Platform API Kimlik Doğrulamayı Öğrenme

Learn Platform REST API'leri kimlik doğrulaması için Microsoft Entra ID kullanır. API çağrıları yapmadan önce bir erişim yöntemi seçmeniz gerekir ve istemci uygulamanızın geçerli kimlik bilgileriyle kimlik doğrulaması yapması gerekir.

Yalnızca uygulama erişimi

Uygulamanız Learn'e doğrudan eriştiğinde, erişimi tek bir kullanıcıya bağlı değildir. Uygulama API'leri doğrudan kendi kimliğini kullanarak çağırır. Bu senaryo yalnızca uygulama erişimidir. Microsoft kimlik platformu hakkında daha fazla bilgi edinin.

Başlamak için Microsoft Kimlik Platformu'nda uygulama kaydı veya yönetilen kimlik olabilecek geçerli bir kimliğe sahip olmanız gerekir. İdeal olarak, kota ve iş ortağı yönetimini basitleştirmek için her iş ortağının tek bir kimliği olmalıdır. Kullanıcı tarafından atanan yönetilen kimlik kullanmak, farklı hizmetler arasında yönetilen kimlikleri birleştirmeye yardımcı olabilir.

Entra ID kimliğiniz ayarlandıktan sonra, kimlik doğrulama kanıtı olarak belirli bir kapsamla ayarlanmış Entra ID'den bir erişim belirteci (tokeni) alın. Learn'e REST API isteklerinde bulunurken erişim belirtecini HTTP Yetkilendirme üst bilgisine ekleyin.

Yetkilendirilmiş erişim

Bir kullanıcı uygulamanızda oturum açtığında ve Learn'e erişmek için bunu kullandığında, uygulamanın önce kullanıcı adına bu kaynağa erişmek için izin istemesi gerekir. Bu senaryoya temsilci erişimi adı verilir. Microsoft kimlik platformu hakkında daha fazla bilgi edinin.

Başlamak için bir uygulama kaydı kaydetmeniz gerekir. Uygulama kaydınız ayarlandıktan sonra uygulamanızın kullanıcıdan kullanıcı adına Learn'e erişmek için belirli bir kapsam veya kapsam kümesi vermesini istemesi gerekir. Learn ayrıntılı kaynak erişimi için kapsamların listesini sağlar. Kapsam listesi şunlardır:

• : Bu kapsam, kullanıcıların Oturum açmış kullanıcı kimliğine bürünülen Learn'deki genel içeriğe erişmesine olanak tanır.

Microsoft Learn Platform API Sürümünü Anlama

API'de kırılma yaratan değişiklikler yapıldığında, yeni ve tarihli bir sürüm yayınlarız. Hataya neden olan değişiklikler, tümleştirmeyi bozabilecek değişikliklerdir. Hataya neden olmayan (eklemeli) değişiklikler desteklenen tüm API sürümlerinde kullanılabilir.

API sürümü api sürümü sorgu parametresi olarak belirtilir ve kararlı sürümler için yyyy-MM-dd ve önizleme sürümleri için yyyy-MM-dd-preview kullanır. Api sürümü sorgu parametresi her API isteği için gereklidir.

Yeni bir kararlı API sürümü yayınlandığında, önceki kararlı API sürümü, yeni API sürümünün yayımlanmasından sonra en az 24 ay daha desteklenir. Önizleme API'leri, yeni önizleme API'lerinin yayımlanmasından sonraki üç ay daha kısa bir destek döngüsüne sahiptir.

Geçerli sürüm 2023-11-01-preview sürümüdür.

Her API'nin önceki /v1/ URL kesimi, API sürümünün değil temel URL'nin bir parçasıdır. Gelecekte önemli API protokolü ve örüntü değişiklikleri için ayrılmıştır.

Platform API'sinde Hız Sınırlamayı Öğrenin

Learn, belirli bir süre içinde yapabileceğiniz REST API isteklerinin sayısını sınırlar. Bu sınır, kötüye kullanım ve hizmet reddi saldırılarını önlemeye yardımcı olur ve API'nin tüm kullanıcılar için kullanılabilir kalmasını sağlar.

Learn, erişim belirtecindeki oid talebine göre hız sınırları uygular. Yalnızca uygulama erişimi için sınır uygulamanın kendisine uygulanırken, temsilci erişimi için bu sınır uygulamada oturum açan kullanıcıya uygulanır.

Varsayılan olarak, hız sınırı dakikada 100 API çağrısıdır ve 5 dakikalık bir zaman aralığı üzerinden hesaplanır. Üretim için daha yüksek bir sınıra ihtiyacınız varsa, artış istemek için Learn Tümleştirme Desteği ile iletişime geçebilirsiniz.

Bilgi arama API'leri gibi bazı API'ler de belirteç tabanlı hız sınırlaması uygular. Bu, varsayılan sınırı dakikada 10.000 belirteç olan Microsoft Azure OpenAI belirteçlerinin tüketilen sayısına bağlıdır. Üretim için bu sınırı artırmak için Learn Tümleştirmeleri Desteği'ne başvurun.

Platform API'sini Sayfalandırmayı Öğrenin

Tüm üst düzey API kaynakları , 'list' API yöntemleri aracılığıyla toplu alma desteği sağlar. Örneğin, modüllerin veya sınavların listesini alabilirsiniz. Bu yöntemler standartlaştırılmış bir yaklaşımdan sonra sayfalandırılmış yanıtlar döndürür.

Liste API'si yöntemleri, yanıt gövdesindeki nextLink alanı tarafından gösterilen imleç tabanlı sayfalandırmayı kullanır. Bu alan, sonuçların sonraki sayfasını getirmek için gereken bilgilerin bulunduğu opak bir URL içerir. Varsayılan olarak, liste API'leri istek başına 30 öğe döndürür, ancak maxpagesize parametresini kullanarak sayfa boyutunu ayarlayabilirsiniz.

İstemci SDK kitaplıklarımız, listenin tüm sayfalarında gezinmek için otomatik sayfalandırma yardımcıları sunar.

İlgili içerik

• Hızlı Başlangıç: Microsoft Learn Platform API'sinin Katalog Verilerini ayarlama ve kullanma
• Platform API Kataloğu Veri Geliştirici Başvurusu'nu öğrenin
• Platform API'si Hakkında SSS