Microsoft Learn Katalog API'sini kullanmaya yönelik en iyi yöntemler
Bu makalede Learn Kataloğu API'sini kullanmaya yönelik en iyi yöntemler açıklanmaktadır.
Hizmet Koşullarını Anlama
Learn Kataloğu API'sinin genel kullanıma açık ve kullanımı ücretsizdir, ancak kullanıcılar Microsoft API Kullanım Koşulları'na tabidir. Learn Catalog API'sini kullanmadan önce ve çıkışı herhangi bir üretim ortamına eklemeden önce API Kullanım Koşulları'nı okuyun ve anlayın.
Learn Kataloğu API'sinin sınırlamalarını anlama
Learn Katalog API'sine Genel Bakış makalesindeki Sınırlamalar bölümüne bakın.
Learn içerik modelini anlama
Learn Kataloğu API'sinin yanıtını etkili bir şekilde kullanmak için, Microsoft Learn'de kullanılabilen içerik türlerini ve bunların birbiriyle ilişkilerini anlamak önemlidir. Daha fazla bilgi için Learn içerik modeli makalesini gözden geçirin.
Özellikle:
- UID, Benzersiz Kimlik anlamına gelir ve her içerik nesnesi için benzersizdir. Bir UID değişirse, başlık veya diğer meta veriler aynı kalsa bile içerik yeni bir nesne olarak kabul edilir.
- Modüller, Learn eğitim kataloğundaki temel nesnedir. Hepsi, uçtan uca bir senaryo veya kavram öğrettikleri ve önkoşul modülleri almayı gerektirmedikleri anlamında kendi başlarına durabilecek kapasitededir. Bazıları için bu budur ve öğrenme yolunun bir parçası değildir. Diğerleri için, bir kullanıcıyı daha gelişmiş kavramlar oluşturmaya götüren bir veya daha fazla öğrenme yolunda birlikte paketlenmiştir. Bir modülün öğrenme yolunun parçası olması gerekmez veya bir veya daha fazla modülün parçası olabilir.
- Birimler tek başına içerik olarak yazılamaz. Bunların modül için belirli bir sırada alınması amaçlanmıştır. Bu nedenle, kullanıcıların orada başlayıp içerikte ilerleyebilmesi için modül ayrıntı sayfasının bağlantısını ve ilk üniteyi ekleyeceğiz.
Learn'de yerelleştirmenin nasıl çalıştığını ve yerelleştirilmiş içeriğin API çıkışına nasıl yansıtıldığını anlama
Microsoft Learn sitede 65'in üzerinde yerel ayarı destekler ve içeriğin çoğu bu yerel ayarlara çevrilir. İçeriği, içerikte öğretilen ürünlerin mevcut olduğu tüm dillerde kullanılabilir hale getirmeyi amaçlıyoruz, ancak tüm yerel ayar deneyimlerinde yerelleştirilmiş içerik mevcut değildir.
Yerel ayar kaydında ilişkili çeviri mevcut olmadığında, sitedeki içerik ve API yanıtı varsayılan olarak İngilizceye "geri döner". API çıkışında, yedekleme gerçekleştiğinde diğer yerel ayar yanıtlarında İngilizce meta veriler görürsünüz. Ancak, ana içerik geri çekilebilse de içeriğin URL'si yine de yerel ayarı gösterir ve bunun nedeni kullanıcının bu yerel ayarda (çevrilmiş üst bilgi/alt bilgi ve çevirisi olan diğer bağlantıları gösterir) sitede gezinmesine izin vermektir.
güncelleştirmeler İngilizce içerikte yayımlandığında, yerelleştirilmiş sürümlerin en kısa sürede güncelleştirilmesi için yerelleştirme işlem hatlarımız çalışır ( genellikle özgün değişikliği izleyen birkaç gün içinde).
Desteklenen yerel ayarların tam listesini Microsoft Learn site alt bilgisinde görebilirsiniz (görüntülediğiniz dili seçin). Bu yerel ayarların her biri, locale filtresi kullanılarak Learn Catalog API'siyle sorgulanabilir.
Eğitim içeriği tamamlama kayıtlarımız yerel ayardan bağımsızdır; başka bir deyişle, içeriğin yerelleştirilmiş sürümlerini kullanıcı eğitimi tamamlama kayıtlarımızda ayrı nesneler olarak ayırmıyoruz. Kullanıcılar eğitimi hangi dilde tamamlarsa tamamlasın, genel nesne için kredi alırlar ve tamamlandığı dili kaydetmeyiz. Bu yerel ayardan bağımsız tamamlanma, öğrenme deneyiminizde Learn Kataloğu API'sini uygularsanız bunu göz önünde bulundurmanız gerektiği anlamına gelir ve içerik nesnelerini ayrı nesneler olarak yüklerseniz, aralarında bir eşdeğerlik sağlamalısınız. Bu şekilde, kullanıcı eğitimi hangi dilde tamamlarsa tamamlasın, diğer dillerde de kredi alır ve eğitimi yeniden almak zorunda kalmaz.
Learn'de içerik sürümü oluşturmanın nasıl çalıştığını ve API çıkışına nasıl yansıtıldığından anlama
Özellikle, içerik sürekli güncelleştiriliyor. Kullanılabilir güncelleştirmeleri günde iki kez yayımlıyoruz. Küçük metin değişiklikleri gibi küçük veya büyük düzeltmeler, eklemeler veya silmeler gibi önemli olabilir. Genel olarak, içerik portföyü binlerce katkıda bulunana sahip büyük, yüksek oranda yönetilen bir açık kaynak proje olarak yönetilir ve bu nedenle değişiklikler her zaman yaşanıyor. Üretim sisteminizde Learn Katalog API'sini kullanıyorsanız, bunun farkında olmanız ve sisteminizin bunu işleyebilmesini sağlamanız gerekir.
Yeni içerik nesneleri eklendiğinde, yanıtta yeni bir nesne (UID tarafından tanımlanır) olarak görünürler. İçerik değiştirildiğinde, içeriği last_modified değerine göre anlayabilirsiniz. İçerik silindiğinde, içerik nesnesi yanıttan kaldırılır. API yanıtında içerik güncelleştirilirken bazen biraz gecikme yaşansa da, kullanıcı içeriğin URL'sini izlediğinde her zaman en güncel bilgileri görür. Silme işlemleri söz konusu olduğunda, eski URL yeni içeriğe veya deneyime veya bir sonraki en iyi seçeneğe yönlendirilir.
Şu anda last_modified tarihinden sonra içerik sürümlerine başvuru bulunmamaktadır.
Verileri düzenli olarak yenileme
İş süreçlerinizi desteklemek için Learn Catalog API'sinden katalog bilgilerini kullanıyorsanız veya site deneyiminizin bir parçası olarak müşteriler için görüntülüyorsanız, içeriği günde en az bir kez yenilediğinizden emin olun.
Özellikle, içerik sürekli güncelleştiriliyor. Kullanılabilir güncelleştirmeleri günde iki kez yayımlıyoruz. Küçük metin değişiklikleri gibi küçük veya büyük düzeltmeler, eklemeler veya silmeler gibi önemli olabilir. Genel olarak, içerik portföyü binlerce katkıda bulunana sahip büyük, yüksek oranda yönetilen bir açık kaynak proje olarak yönetilir ve bu nedenle değişiklikler her zaman yaşanıyor. Üretim sisteminizde Learn Katalog API'sini kullanıyorsanız, bunun farkında olmanız ve sisteminizin bunu işleyebilmesini sağlamanız gerekir.
Geliştirici belgelerinin önerilerini gözden geçirin
Learn Kataloğu API'sinin geliştirici belgeleri yanıt kapsamında sağlanan verilerin tam listesine ve her alanın harika öğrenme deneyimlerini desteklemek için nasıl kullanılması önerileceğine ilişkin önerilere sahiptir.
Sorgu mantığını anlama
Yalnızca aradığınızı elde edebilmeniz ve daha küçük dosya boyutlarını işleyebilmeniz için yanıtı önceden filtrelemek için kullanabileceğiniz birçok filtre vardır. Sorgu filtrelerinin tam listesini Learn Catalog API Geliştirici başvuru makalesinde görebilirsiniz. Özellikle sorguyu doğru oluşturmanız gerekir ve istekte birden fazla sorgu parametresi kullanıyorsanız sorgu AND işleci kullanılarak değerlendirilir.
Sonraki adımlar
Learn Kataloğu API'sini desteklemeye yönelik daha fazla bilgi için aşağıdaki makaleleri gözden geçirin: