Dokümantasyon ve Destek Kılavuzları

Udemy Business API'leri, size yazılım geliştirme alanında daha fazla esneklik sunabilmek için çeşitli farklı yöntemlerle entegrasyon işlevleri sağlar.  Bu makalede, her biriyle ilgili bazı potansiyel kullanımlar ve hangisini seçeceğinize dair öneriler açıklanmıştır.

• Udemy'nin desteklediği İş Ortağı Entegrasyonu kullanım senaryolarını inceleyin.

İçindekiler

• Kurslar ve tüm öğrenim nesneleri
• Raporlama
• Öğrenim yolları
• Çoklu oturum açma (SSO)
• Eski Kurslar API'si
• Önerilen sınıfının en iyisi entegrasyon

Kurslar ve tüm öğrenim nesneleri

GraphQL Kursları API'si - Protokol: GraphQL 

• Geleneksel kurslar API'sinin gelişmiş ve yeni nesil versiyonu. GraphQL'de her kurs için yalnızca belirttiğiniz kurs meta verilerini edinmenize olanak tanırız. Ayrıca GraphQL'in sorgu sisteminden yararlanarak belirttiğiniz kriterlere uygun kursları getirme imkanı sunarız. 

Lütfen dikkat: GraphQL'in arkasındaki genel teknoloji hakkında daha fazla bilgi edinmek için GraphQL Kuruluş Sayfasını ziyaret edin.

GraphQL Tüm Öğrenim Nesneleri API'si - Protokol: GraphQL 

• Udemy, öğrenim için kursların ötesinde çok çeşitli yöntemler sunar.  Sisteminizle entegre olmak için tüm öğrenim nesnelerini API üzerinden açığa çıkarırız.  Bu API; kursları, uygulamalı çalışmaları veya rozetleri edinmenizi sağlar.  Diğer GraphQL hizmetlerinde olduğu gibi, yalnızca belirttiğiniz nesneleri ve alanları edinmek için sorguları kullanabilirsiniz.

Belgeler: GraphQL belgelerini edinmek için Udemy Business erişiminiz olmalıdır. Bu URL adresinden Geliştirici Portalını ziyaret edin: https://{your_subdomain}.udemy.com/dev-portal/api-reference/

Raporlama

Raporlama API'si - Protokol: RESTful 

• BU API, öğrenim dahilindeki ilerleme durumu, tamamlanma durumu ve eylemler ile ilgili toplanan tüm kullanıcı verilerini içerir.  Tüm kullanıcı raporlama verilerini edinmeyi tercih edebilir veya bir grup kullanıcı seçebilirsiniz. Veri miktarı nedeniyle kullanıcı eylemlerinin toplanması ve raporlanması gecikebilir.

Belgeler: Udemy Business API Belgeleri - RESTful API'leri

xAPI - Protokol: xAPI

• Web kancası yoluyla sunulan ve xAPI EdTech standartlarına göre oluşturulan gerçek zamanlı raporlama.  Udemy, gerçek zamanlı ilerleme durumu ve raporlama verilerinin size gerçekleştiği anda iletilmesini sağlar.  Bu gerçek zamanlı olaylarda yer alan veriler, RESTful raporlama API'sine kıyasla daha dar bir kapsama sahiptir.

Belgeler: Udemy Business xAPI Belgeleri

Öğrenim yolları

Öğrenim yolu API'si - Protokol: RESTful 

• Udemy, öğrencilerin ve Öğrenim ve Gelişim departmanı yöneticilerinin öğrenim yolları, çeşitli kurslardan oluşan bir koleksiyon, başka herhangi türde bir öğrenim nesnesi ve hatta harici bağlantılar oluşturmasına olanak tanır. Bu öğrenim yollarını API üzerinden açığa çıkarırız ve bunların içindeki tüm yolları ve öğeleri getiririz.

Belgeler: Udemy Business API Belgeleri - RESTful API'leri

Çoklu oturum açma (SSO)

Udemy Business, çoğu SSO sağlayıcısını içeren tüm SAML 2.0 çoklu oturum açma hizmetlerine bağlanabilir. Ayrıca, SAML 2.0 standardına uygun olduğu sürece özel SSO entegrasyonları da kullanılabilir.

Protokol: SAML 2.0+

Belgeler: Udemy Business SSO ve Temel Özelliklere Genel Bakış

SCIM Kullanıcı Provizyonlama API'leri - Etki Alanları Arası Kimlik Yönetimi Sistemi (SCIM) Provizyonlama, kullanıcı lisanslarını yetkilendirmenize ve yetkilendirmelerini kaldırmanıza olanak tanır. Bu sistem, BT ekiplerinizin veya özel entegrasyonlarınızın lisans yönetim işlevlerini otomatikleştirmesini sağlar.

Protokol: SCIM

Belgeler: ​​Etki Alanları Arası Kimlik Yönetimi Sistemi (SCIM) Provizyonlama

Eski Kurslar API'si 

Kurslar API'si - Protokol: RESTful 

• Kurslar API'si, geleneksel EdTech normlarını izler. Tek bir kurs veya tüm kurslar için kurs meta verilerinin tamamını edinir.

Lütfen unutmayın: Bu, eski kurslar API'mizdir ve bu API ile ilgili herhangi bir yeni işlev kullanıma sunulmayacaktır.  Tüm yeni özellikler, yalnızca kursları değil tüm öğrenim nesnelerini de içeren GraphQL API'lerimizde kullanıma sunulacaktır.

Belgeler: Udemy Business API Belgeleri - RESTful API'leri

Önerilen sınıfının en iyisi entegrasyon

Her Udemy müşterisinin ve iş ortağının birbirinden farklı olduğunu ve farklı ihtiyaçlara sahip olabileceğini biliyoruz. Sınıfının en iyisi entegrasyon için şu API'leri kullanmanızı öneririz:

1. Kurslar ve öğrenim nesneleri: Tüm öğrenim nesnelerine erişim için GraphQL API'sini kullanın

2. Raporlama: Tam veri kapsamı için REST API'sini kullanın ve gerçek zamanlı veriler için xAPI kullanarak bunu destekleyin

3. SSO: Kullanıcıları yetkilendirme ve yetkilendirmelerini kaldırma işlemlerini otomatikleştirmek için SCIM ile birlikte kullanılmalıdır

4. Öğrenim yolları: Öğrenim ve Gelişim departmanı yöneticilerinin ve program liderlerinin son kullanıcı için öğrenim yolları oluşturabilmesine olanak tanımak amacıyla Öğrenim Yolu API'sini kullanın.

Udemy Business - Öğrenim yoluyla yaşamları iyileştiriyoruz

Udemy'nin öğrenim motoruna erişin ve insanların online platformlarınız, hizmetleriniz ve Udemy öğrenim hizmetleri ile etkileşim kurmasını sağlayan çeşitli ölçekte bağlantı çözümleri ve en iyi sürümlere sahip Uygulamalar ile ağlarınız ve ekosistemlerimiz genelinde profesyonel geliştirme içerikleri sunun. 

Udemy Business, pazar değişiklikleriyle aynı hızda oluşturulan ve güncellenen binlerce kurs sunar (yani Öğrenim Motoru).  Kodlamadan işletme yetkinliklerine, kişisel gelişime ve daha fazlasına kadar Udemy, insanların profesyonel hedeflerine ulaşıp iş sonuçları elde etmesine yardımcı olan yüksek kaliteli, talep gören online kurslar içerir.

Amaca uygun geliştirilen Udemy Business entegrasyonu ile Hizmetleriniz, eksiksiz kurs deneyimi için özel bir Udemy Business sitesi sunma olanağıyla birlikte kullanıcılara en yüksek puan alan Udemy Business kurslarını (ve öğrenim yollarını) Platformunuzdan yerel olarak Arama ve Keşfetme imkanı sunar. 

İçindekiler:

Kullanım senaryosu 1: İçerik entegrasyonu

Temel avantajlar

Kullanım senaryosu 2: Kullanıcı ilerleme durumu ve analizler

Temel avantajlar

Entegrasyon zaman çizelgesi ve kilometre taşları

Üst düzey referans mimarisi

Udemy Business entegrasyonu, aşağıdaki iki temel kullanım senaryosuna olanak tanır: 

Kullanım senaryosu 1: İçerik entegrasyonu

İçerik entegrasyonları, Udemy Business online öğrenim içeriklerine (yani kurslar ve öğrenim yolları) erişimin kapsamını genişletir ve temel online Hizmet tekliflerinizi güçlendirir.  Udemy Business İçerik Entegrasyonu ile İş Ortakları, doğrudan İş Ortağının Yerel Web ve/veya Yerel Mobil Uygulamalarında Udemy Business online kurslarına ve öğrenim yollarına (yapılandırılmış öğrenim hedefleri) yönelik Arama ve Keşfetme işlevlerini içeren bir erişim imkanı sunabilir.  Kullanıcılarınız, derlenmiş Udemy içeriklerini (veya Öğrenim Yollarını) tanıdık yerel bir deneyimde keşfedebilir ve bunlarla etkileşim kurabilir.  Entegre Udemy Business içeriği, İş Ortağı Site ve Hizmetleri ile sorunsuz bir etkileşim arayüzü sunarak kullanıcılara (ve İş Ortaklarına) fayda sağlar.  İçerik Entegrasyonu, güçlü bir online Öğrenim Motoruna bağlanan modern Web Hizmetleri (yani API'ler) yoluyla etkinleştirilir.  Udemy, İş Ortaklarının yerel Web (veya Mobil) Uygulama deneyimini desteklemek amacıyla Konektörün oluşturulmasına, test edilmesine, dağıtımına ve yaşam döngüsü yönetimine yönelik rehberlik dahil olmak üzere İçerik Entegrasyonu Konektörünün kapsamı ve tasarımıyla İş Ortaklarını destekler. 

Temel avantajlar:

• Doğrudan Web ve yerel mobil Uygulamalarınızdan profesyonel ve kişisel gelişim için en yeni online öğrenim içeriklerine erişin
• Sorunsuz otomatik senkronizasyon ile mevcut içerikle etkileşimi artırın
• Sezgisel arama ve keşfetme deneyimi ile içeriklerde kolayca gezinin
• Neredeyse gerçek zamanlı bir şekilde öğrenim ilerleme durumunu izleyin ve çalışan gelişimini destekleyin
• Çoklu oturum açma (SSO) hizmetleriyle kolay ve güvenli erişim
• Hareket halinde öğrenim deneyimi için öğrenimi Yerel Mobil ve Mobil Uygulamanıza taşıyın

Kullanım senaryosu 2: Kullanıcı ilerleme durumu ve analizler

Udemy Business öğrenci verilerini entegre ederek kullanıcılarınızın öğrenim ihtiyaçlarına dair içgörüler edinin. Kullanıcı kurs etkileşimini, ilerleme durumunu ve tamamlanma oranlarını analizlerinize dahil ederek kişilerin ihtiyaçlarını ve temel konseptleri (yani amaca uygun geliştirilen öğrenim yolları) anlayıp sürekli olarak rehberli deneyimler geliştirebilir ve bunları kişiselleştirebilirsiniz.  Öğrenim Analizleri, kullanıcı öğrenim deneyimlerini sürekli olarak iyileştirmek amacıyla İş Ortaklarımızın benzersiz veri setleri genelinde kullanıcılarına dair birleştirilmiş öğrenim düzenleri geliştirmelerini sağlayarak kullanıcı etkileşimi sinyalleriyle ilgili zengin bir veri setinden yararlanır. 

Temel avantajlar:

• Kullanıcılarınızın öğrenim ihtiyaçlarındaki temel sinyalleri görmek için birleştirilmiş öğrenim analizleri geliştirin
• Udemy Business içeriğinizi hedef kitlenize uygun hale getirmek için öğrenim içgörülerini kullanın
• Kullanıcılarınızın benzersiz ihtiyaçlarını ve ilgi alanlarını tanımlamak için makine zekası ile Hizmet Tekliflerinizi güçlendirin
• Bütünsel bir öğrenim deneyimini ve paket halinde Hizmetleri tanıtan kapsamlı bir öğrenim deneyimini sürekli olarak ölçün ve geliştirin

Udemy Business Hizmetleri ve güçlü Udemy Öğrenim Motoru ile geliştirilmiş Udemy İş Ortağı ekosistemini keşfedin 

Entegrasyon zaman çizelgesi ve kilometre taşları

İş Ortaklarının, yukarıdaki kullanım senaryolarını desteklemek üzere API tabanlı bir Konektörün tasarımı, geliştirilmesi ve dağıtımı için ortalama 4 hafta harcadığını görüyoruz.  Udemy Business, Udemy API'leriyle entegrasyonu optimize etmeye yönelik en iyi uygulamalarla ilgili olarak İş Ortaklarına rehberlik etmek ve tavsiye vermek için Konektör geliştirme projesi üzerinden bir İş Ortağı Lideri ve Çözüm Mühendisi atar. 

Üst düzey referans mimarisi

Entegrasyonun temel bileşenleri aşağıda tanımlanmıştır.  Veri senkronizasyonu, Udemy Business API'leri ile desteklenir ve İş Ortağı tarafından oluşturulan Konektör tarafından düzenlenir.  Udemy kurslarını ve öğrenim yollarını Arama ve Keşfetme işlevi, doğrudan İş Ortağı yerel Web ve Mobil Uygulamalarında Konektör aracılığıyla etkinleştirilir. 

İsteğe bağlı çoklu oturum açma ile kullanıcılar, doğrudan İş Ortağı öğrenim platformundan Udemy Business sitesine sorunsuz bir şekilde bağlanır. 

Entegrasyonunuz için hızlı başlangıç kılavuzu

Ortak müşterilerimiz için yeni pazarlara açılabilmek amacıyla entegrasyonunuzun hızla yayına girmesini istiyoruz. 

Udemy Business Entegrasyonlar sayfası, aşağıda gösterilmiştir

Ön koşul adımları

• İş ortaklığı başvurusu gönderilir ve onaylanır
• Udemy, Udemy Business için korumalı alan ortamı sağlar
• Udemy yöneticisi, diğer kullanıcıları davet eder

Bunlardan herhangi biri eksikse lütfen önce bunları tamamlamak için (Başlangıç Kılavuzuna) bakın

İş ortağı entegrasyonu kullanım senaryoları: Bu entegrasyon adımlarının desteklediği üst düzey kullanım senaryolarını incelemek istiyorsanız.  İstemiyorsanız geliştirme aşamasına geçebiliriz.

Geliştirme adımları

Önerdiğimiz en iyi uygulama, önce tüm Udemy API'lerine bağlanıp ardından tüm uç noktaların çalıştığı doğrulandıktan sonra yazılım geliştirmeye başlayarak teknik riski en aza indirmektir.

• Kurslar API'sine bağlanın, en az 10 kurs getirin
• Kurs API'sine bağlanın, 1 kurs getirin
• Udemy Business sitenizde oturum açın ve bir kursa kaydolun, en az 1 dakikalığına bir ders izleyin (Oynatma hızını artırabilirsiniz)
• Raporlama API'sine bağlanın (kullanıcı-etkinlik)
• Raporlama API'sine bağlanın (kullanıcı-kurs-etkinlik)
• Raporlama API'sine bağlanın (öğrenim-etkinlik-deneme)
• Udemy Business sitenizde oturum açın ve bir Öğrenim Yolu (belgeler) oluşturun, bir kurs açın ve bu kursu, az önce oluşturduğunuz öğrenim yoluna ekleyin
• Öğrenim Yolu API'sine bağlanın, oluşturduğunuz öğrenim yolunu getirin

Yapılandırmalar

API'lerin çoğu çalışır durumda olduğunda yapılandırma adımlarına geçebilirsiniz.

• Çoklu Oturum Açma (SSO) yapılandırması, doğrudan Udemy Business Ayarlar sayfanızdan yapılır.  Bu ayarlara erişmek için yönetici kimlik bilgilerine sahip olmanız gerekir.  Çok sayıda sağlayıcımızdan biriyle kullanıma hazır SSO'yu kurun.  Alternatif olarak, SAML 2.0 ile özel bir bağlantı oluşturun (SSO belgelerinin bağlantısı)
• [Udemy Business: Yönet: Ayarlar] bölümündeki diğer ayarları inceleyin ve istediğiniz şekilde özelleştirin

Geliştirmeler

Öğrenim Yolları - Kullanıcıların, öğrenciyi yönlendirecek bir başlangıcı ve sonu olan çeşitli öğrenim kaynaklarından oluşan bir müfredat oluşturmasına olanak tanır.

• Udemy Business sitenizde oturum açın ve bir Öğrenim Yolu (belgeler) oluşturun, bir kurs açın ve bu kursu, az önce oluşturduğunuz öğrenim yoluna ekleyin
• Öğrenim Yolu API'sine bağlanın; oluşturduğunuz öğrenim yolunu getirin
• Raporlama API'sine (öğrenim-yolu-etkinliği) bağlanın

Web kancası yoluyla gerçek zamanlı raporlama

• Kurulum xAPI'si - Öğrencinin ilerleme durumuna ve tamamlanma olaylarına dair raporlama verileri için Udemy'nin web kancası (belgeler).  Udemy yönetici ayarları sayfasına parametreler ekleyeceksiniz.
• Kurulumun ardından maksimum oynatma hızında kısa bir ders izleyin ve ilerleme durumu verilerini alıp almadığınıza bakın.

Kurs verilerini sorgulama veya arama - Udemy'nin GraphQL API'sini kullanarak kurs kataloğumuzda sorgu işlevini kullanmanıza ve yalnızca ilgili kullanım senaryosu için ihtiyacınız olan verileri almanıza olanak tanırız.  Ayrıca girdinizi ve filtrelerinizi alarak ilgili kurs sonuçları getiren bir Arama API'si de sunarız.

• GraphQL API kimlik bilgilerini edinin
• GetAuthToken() adlı GraphQL işlevini çağırın
• Kurslar API'sini çağırmak için [authToken] ifadesini kullanın
• CourseSearch API'sini çağırın

Not: GraphQL Belgelerine erişmek için Udemy Business'ta oturum açmanız gerekir. İlgili URL, kuruluşunuzun Udemy hesabına yönelik alt etki alanını ve ardından .udemy.com/dev-portal/api-reference/ ifadesini içerir. 

Örneğin:

https://{alt_etki_alaniniz}.udemy.com/dev-portal/api-reference/.

Temel yazılım geliştirme

Tüm Udemy kimlik bilgileri çalıştığında, tüm API'lere bağlanıldığında ve ek yapılandırmalar kurulduğunda teknik risk ortadan kalkar.  Çoğu iş ortağı, planlama aşamasına veya doğrudan geliştirme aşamasına geçer.  Başlamanın bir yolu da kullanıcı hikayelerinin veya desteklenen kullanım senaryolarının listesini almak ve her bir kullanım senaryosu için gereken Udemy API'lerini eşleştirmektir.  Bu aşamadan sonra yazılım mühendisliği ekibinize bol şans diliyoruz! 

Hata giderme, istisnalar ve en iyi uygulamalar

Hata giderme, istisnalar ve uç senaryolarını dahil ederek yazılımınızı güçlendirin.  Beklenmeyen BT sorunlarını gidermek için çok çeşitli hata giderme önerilerimiz bulunmaktadır. 

• API'ler tarafından döndürülen hata yanıtlarını kaydedin
• API çağrılarına yeniden deneme mantığı ekleyin
• sayfa_boyutu en iyi uygulamalarını kullanarak oran sınırlarını ele alın
• Belgede yer alan diğer en iyi uygulamaları gerçekleştirin

Daha fazla destek ve geri bildirim için veya yeni entegrasyonunuzun tamamlanmasının ardından lütfen partnersupport@udemy.com adresinden bizimle iletişime geçin.  Yeni ortak işlevselliğimiz ile birlikte yeni pazarlara açılmayı sabırsızlıkla bekliyoruz.

Udemy Business teknoloji iş ortakları, UB içerik koleksiyonu ile öğrenci etkinlik verilerinin iş ortağı platformuna otomatik senkronizasyonunu sağlamak için Platform API'lerinden yararlanır. Entegrasyonlar yalnızca karşılıklı müşterilerin kullanımına yöneliktir. Udemy Business ile bir entegrasyon kurmaya hazır mısınız? Başlamanıza yardımcı olacak belgeleri aşağıda bulabilirsiniz.

• Kullanılabilir API'lerin özeti
•  Udemy Business Web API'leri: Kullanım Senaryoları ve En İyi Uygulamalar
• İş Ortağı Entegrasyonu Kullanım Senaryoları
• Teknoloji İş Ortakları İçin Entegrasyon Adımları

Udemy Business Web API'leri (REST/GraphQL/xAPI) ile yönetici araçlarınızı, LMS platformunu ve İK paketlerini Udemy'nin kurs kataloğuyla (metaveri üzerinden) bağlamanın yanı sıra öğrenci etkileşimi verilerinizi de bağlayın.

Öğrenim yoluyla iş yerinizi güçlendirin:

• Udemy Business ve çalışan dizininiz (ör. Okta, Azure) arasında otomatik kullanıcı verileri senkronizasyonu
• Udemy Business kurslarınıza ve kurs derslerinize ilişkin arama, keşfetme ve başlatma işlemlerini İK sistemlerine entegre edin.
• Doğrudan uygulamalarınız üzerinden kuruluşunuz için gerçek zamanlı kurs katılımı analizleri çekin

Aşağıda referans verilen ve bağlantısı sunulan kılavuz, Udemy Business Yardım Merkezi'nde yayınlanmıştır.

Daha fazla bilgi edinin: Udemy Business Web API'leri: Kullanım Senaryoları ve En İyi Uygulamalar