Przewodniki po dokumentacji i wsparciu

Aby umożliwić Ci większą elastyczność przy opracowywaniu oprogramowania, w API Udemy Business mona używać funkcji integracji z zastosowaniem szeregu różnych metod.  W niniejszym artykule przedstawiamy niektóre z możliwych zastosowań w przypadku każdej z nich, a także zalecenia dotyczące tego, którą wybrać.

• Zapoznaj się z przypadkami zastosowań Integracji Partnerskiej, które Udemy obsługuje

Spis treści

• Kursy i wszystkie obiekty edukacyjne
• Raportowanie
• Ścieżki nauki
• Logowanie jednokrotne (SSO)
• Starsze API kursów
• Rekomendowana, najlepsza w swojej klasie integracja

Kursy i wszystkie obiekty edukacyjne

API kursów GraphQL – Protokół: GraphQL 

• Nowa generacja i ewolucja do tradycyjnych API kursów. W GraphQL, w przypadku każdego kursu, umożliwiamy pozyskiwanie jedynie tych metadanych kursu, które wskażesz. Dodatkowo stosowanie systemu zapytań GraphQL pozwala na wyszukiwanie kursów spełniających Twoje kryteria. 

Uwaga: Aby dowiedzieć się więcej o ogólnym rozwiązaniu, na którym opiera się działanie GraphQL, zajrzyj na stronę GraphQL Organization.

API dla wszystkich obiektów edukacyjnych GraphQL – Protokół: GraphQL 

• Udemy oferuje wiele różnych sposobów na naukę, także poza kursami.  Eksponujemy wszystkie obiekty edukacyjne za pośrednictwem API w celu ich integracji z Twoim systemem.  Ten API pozwala na korzystanie z kursów, laboratoriów i odznak.  Tak, jak w przypadku innych usług GraphQL, możesz korzystać z zapytań, aby uzyskiwać interesujące Cię obiekty i pola.

Dokumentacja:  Aby uzyskiwać dokumentację GraphQL, musisz mieć dostęp do Udemy Business. Zajrzyj do Portalu dla programistów: https://{twoja_subdomena}.udemy.com/dev-portal/api-reference/

Raportowanie

API do raportowania – Protokół: RESTful 

• Ten API zawiera wszystkie zgromadzone dane użytkowników dotyczące postępów, ukończonych etapów i działań w kontekście nauki.  Możesz wybrać otrzymywanie danych raportowych wszystkich użytkowników lub określić grupę użytkowników. Ze względu na ilość danych pojawiają się pewne opóźnienia w zakresie działań użytkowników, o których informacje mają być gromadzone i na temat których mają być tworzone raporty.

Dokumentacja: Dokumentacja interfejsów Udemy Business API – API typu RESTful

xAPI -– Protokół: xAPI

• Raportowanie w czasie rzeczywistym poprzez webhook stworzony wedle standardów EdTech xAPI.  Udemy umożliwia przesyłanie danych o postępach oraz danych raportowania w czasie rzeczywistym.  Dane zawarte w tych zdarzeniach, o których informacja jest przekazywana w czasie rzeczywistym, obejmują mniejszy zakres w porównaniu do API do raportowania RESTful.

Dokumentacja: Dokumentacja xAPI Udemy Business

Ścieżki nauki

API do ścieżek nauki – Protokół: RESTful 

• Udemy umożliwia uczestnikom kursów i administratorom L&D tworzenie ścieżek nauki, kolekcji zawierających po kilka kursów, a także wszelkich innych rodzajów obiektów edukacyjnych, a nawet linków zewnętrznych. Ścieżki nauki udostępniamy za pośrednictwem API i pokazujemy wszystkie zawarte w nich pozycje.

Dokumentacja: Dokumentacja interfejsów Udemy Business API – API typu RESTful

Logowanie jednokrotne (SSO)

Udemy Business może łączyć się ze wszystkimi usługami pojedynczego logowania SAML 2.0. Obejmuje to większość usługodawców SSO. Dodatkowo dostępne są spersonalizowane integracje SSO, o ile spełniają one wymogi standardu SAML 2.0.

Protokół: SAML 2.0+

Dokumentacja: Ogólne omówienie SSO i głównych funkcji Udemy Business

API do świadczenia użytkownikom usług SCIM – System do świadczenia usług do zarządzania tożsamością w wielu domenach (SCIM) umożliwia zarówno udzielanie, jak i wycofywanie licencji użytkowników. System ten pozwala twoim zespołom informatycznym lub spersonalizowanym integracjom na automatyzację funkcji zarządzania licencjami.

Protokół: SCIM

Dokumentacja: ​​System świadczenia usług do zarządzania tożsamością w wielu domenach (SCIM)

Starsze API kursów 

API kursów – Protokół: RESTful 

• API kursów spełnia tradycyjne normy EdTech. Pozwala uzyskiwać wszystkie metadane pojedynczego kursu albo wielu kursów.

Uwaga: To nasz starszy API kursów, dla którego nie będziemy udostępniać nowych funkcji.  Wszystkie nowe funkcje będą udostępniane w naszych API GraphQL, które zawierają nie tylko kursy, ale także wszystkie obiekty edukacyjne.

Dokumentacja: Dokumentacja interfejsów Udemy Business API – API typu RESTful

Rekomendowana, najlepsza w swojej klasie integracja

Wiemy, że każdy klient i partner Udemy jest inny i może mieć indywidualne potrzeby. Aby zapewnić najlepszą w swojej klasie integrację, zalecamy korzystanie z następujących API:

1. Kursy i obiekty edukacyjne: Korzystaj z API GraphQL, aby uzyskać dostęp do wszystkich obiektów edukacyjnych

2. Raportowanie: Korzystaj z API typu REST, aby uzyskać pełny zakres danych, dodatkowo korzystając z xAPI pozwalającego uzyskiwać dane w czasie rzeczywistym

3. SSO: Z tej funkcji powinno się korzystać w połączeniu ze SCIM, aby zautomatyzować zarówno udzielanie, jak i wycofywanie licencji użytkowników

4. Ścieżki nauki: Korzystaj z API do ścieżek nauki, aby umożliwić administratorom L&D oraz liderom programów tworzenie ścieżek nauki dla użytkownika końcowego.

Udemy Business – podnosimy jakość życia dzięki nauce

Uzyskaj dostęp do silnika edukacyjnego Udemy i dostarczaj treści związane z rozwojem zawodowym w swoich sieciach i ekosystemach dzięki skali rozwiązań łączności i najlepszym wersjom aplikacji, które przyciągną uczestników do Twoich platform i usług internetowych oraz usług edukacyjnych Udemy. 

Udemy Business to tysiące kursów tworzonych i aktualizowanych z szybkością dostosowaną do tempa zmian na rynku (silnik edukacyjny).  Od programowania, przez umiejętności biznesowe, po rozwój osobisty i znacznie dalej – Udemy oferuje poszukiwane kursy internetowe wysokiej jakości, które pomagają ludziom osiągnąć cele zawodowe i wyniki biznesowe.

Dzięki specjalnie zaprojektowanej integracji z Udemy Business Twoje usługi będą umożliwiać użytkownikom wyszukiwanie i odkrywanie najlepiej ocenianych kursów (i ścieżek nauki) Udemy Business bezpośrednio na Twojej platformie, z możliwością przejścia do dedykowanej witryny Udemy Business w celu przejścia całego kursu. 

Spis treści:

Przypadek użycia 1: Integracja treści

Główne korzyści

Przypadek użycia 2: Postępy użytkowników i analityka

Główne korzyści

Ramy czasowe i kamienie milowe integracji

Ogólna architektura referencyjna

Integracja z Udemy Business obsługuje następujące dwa podstawowe przypadki użycia: 

Przypadek użycia 1: Integracja treści

Integracje treści rozszerzają dostęp do internetowych usług edukacyjnych Udemy Business (tj. kursów i ścieżek nauki) i wzmacniają Twoją podstawową ofertę usług internetowych.  Poprzez integrację treści z Udemy Business partnerzy mogą oferować dostęp z możliwością wyszukiwania i odkrywania do kursów internetowych i ścieżek nauki Udemy Business (uporządkowanych celów edukacyjnych) bezpośrednio w swoich aplikacjach internetowych i/lub mobilnych.  Twoi użytkownicy będą mogli odkrywać i subskrybować wyselekcjonowane treści (lub ścieżki nauki) Udemy w znanym sobie środowisku.  Zintegrowane treści Udemy Business przynoszą korzyści użytkownikom (i partnerom) za sprawą bezproblemowego interfejsu zaangażowania w witrynie i usługach partnera.  Integracja treści jest realizowana za pomocą nowoczesnych usług internetowych (tj. interfejsów API), które łączą się z wydajnym internetowym silnikiem edukacyjnym.  Udemy wspiera partnerów zakresem i konstrukcją łącznika Content Integration, a także pomocą merytoryczną w tworzeniu, testowaniu, wdrażaniu i zarządzania cyklem życia łącznika w natywnych aplikacjach internetowych (lub mobilnych) partnerów. 

Główne korzyści:

• Dostęp do najnowszych internetowych treści edukacyjnych w zakresie rozwoju zawodowego i osobistego bezpośrednio w aplikacjach internetowych i natywnych aplikacjach mobilnych partnera
• Ułatwienie korzystania z bieżących treści dzięki sprawnej synchronizacji automatycznej
• Łatwa nawigacja w treściach dzięki intuicyjnemu wyszukiwaniu i odkrywaniu.
• Monitorowanie postępów w nauce w czasie rzeczywistym i wspieranie rozwoju pracowników
• Łatwy i bezpieczny dostęp dzięki usługom jednokrotnego logowania (SSO)
• Możliwość przeniesienia nauki do własnej aplikacji internetowej i mobilnej na potrzeby nauki w podróży

Przypadek użycia 2: Postępy użytkowników i analityka

Uzyskuj spostrzeżenia dotyczące potrzeb edukacyjnych Twoich użytkowników dzięki integracji danych uczestników z Udemy Business. Poprzez uwzględnienie w analityce danych uczestnictwa użytkowników w kursach, ich postępów i wskaźników ukończenia można na bieżąco personalizować i rozwijać doświadczenia kierowane uwzględniające indywidualne potrzeby i kluczowe koncepcje (np. specjalnie budowane ścieżki nauki).  Analityka nauki wykorzystuje bogaty zbiór danych sygnałów zaangażowania użytkowników, umożliwiając naszym partnerom znajdowanie złożonych schematów nauki w unikalnych zbiorach danych w celu stałej poprawy zdobywania wiedzy przez użytkowników. 

Główne korzyści:

• Rozwijanie złożonej analityki nauki umożliwiającej znajdowanie kluczowych sygnałów dotyczących potrzeb edukacyjnych użytkowników
• Wykorzystywanie spostrzeżeń dotyczących nauki do dostosowywania treści Udemy Business do potrzeb odbiorców
• Poprawa oferty usług dzięki identyfikacji unikalnych potrzeb i zainteresowań użytkowników za pomocą sztucznej inteligencji
• Ocena i rozwijanie na bieżąco kompleksowych rozwiązań edukacyjnych promujących całościowe doświadczenia edukacyjne i pakiety usług

Rozwijaj swoją firmę dzięki usługom Udemy Business i wydajnemu silnikowi edukacyjnemu Udemy – poznaj ekosystem partnerski Udemy 

Ramy czasowe i kamienie milowe integracji

Nasi partnerzy poświęcają przeciętnie 4 tygodnie na projektowanie, rozwijanie i wdrażanie łącznika opartego na interfejsach API do obsługi powyższych przypadków użycia.  W ramach projektu budowy łącznika Udemy Business wyznacza opiekuna partnera i inżyniera rozwiązań, którzy prowadzą partnera i doradzają mu w zakresie najlepszych praktyk dotyczących optymalizacji integracji z interfejsami Udemy API. 

Ogólna architektura referencyjna

Podstawowe składniki integracji zostały przedstawione poniżej.  Synchronizacja danych jest obsługiwana przez interfejsy Udemy Business API i koordynowana przez łącznik utworzony przez partnera.  Łącznik umożliwia wyszukiwanie i odkrywanie kursów i ścieżek nauki Udemy bezpośrednio w natywnych aplikacjach internetowych i mobilnych partnera. 

Dzięki opcjonalnej funkcji jednokrotnego logowania użytkownicy sprawnie łączą się z witryną Udemy Business bezpośrednio z platformy edukacyjnej partnera. 

Skrócona instrukcja integracji

Chcemy Ci umożliwić szybkie uruchomienie integracji, aby nasze firmy mogły otworzyć nowe rynki dla naszych wspólnych klientów. 

Poniżej przedstawiono stronę Integracje Udemy Business

Wymagane czynności wstępne

• Podpisanie umów prawnych
• Udemy konfiguruje i udostępnia środowisko dla Udemy Business
• Zaproszenie do zalogowania się od Udemy

Jeśli któraś z tych czynności nie została jeszcze wykonana, zadbaj o nie w pierwszej kolejności, korzystając z przewodnika Jak rozpocząć.

Przypadki użycia integracji przez partnerów: zapoznaj się z tym dokumentem, jeśli chcesz poznać ogólne przypadki użycia obsługiwane przez te etapy integracji.  W przeciwnym razie możemy przejść do etapu programowania.

Etap programowania

Zalecaną przez nas najlepszą praktyką umożliwiającą zmniejszenie ryzyka technicznego jest nawiązanie w pierwszej kolejności połączenia z wszystkimi interfejsami API Udemy i rozpoczęcie tworzenia oprogramowania po potwierdzeniu działania wszystkich punktów końcowych.

• Nawiąż połączenie z interfejsem Courses API, zwróć co najmniej 10 kursów
• Nawiąż połączenie z interfejsem Course API, zwróć 1 kurs
• Zaloguj się do swojej witryny Udemy Business i zapisz się na kurs, po czym oglądaj wykład przez co najmniej 1 minutę (możesz zwiększyć prędkość odtwarzania)
• Nawiąż połączenie z interfejsem Reporting API (user-activity)
• Nawiąż połączenie z interfejsem Reporting API (user-course-activity)
• Nawiąż połączenie z interfejsem Reporting API (learning-activity-attempt)
• Zaloguj się do swojej witryny Udemy Business i utwórz ścieżkę nauki (dokumentacja), po czym otwórz kurs i dodaj go do właśnie utworzonej ścieżki nauki
• Nawiąż połączenie z interfejsem Learning Path API, zwróć utworzoną przez siebie ścieżkę nauki

Konfiguracje

Jeśli większość interfejsów API działa, możesz przejść do etapu konfiguracji.

• Konfigurację logowania jednokrotnego (SSO) przeprowadza się bezpośrednio na stronie ustawień Udemy Business.  Aby uzyskać dostęp do tych ustawień, musisz mieć dane logowania administratora.  Możesz ustawić gotową usługę SSO jednego z naszych wielu dostawców  lub utworzyć niestandardowe połączenie za pomocą SAML 2.0 (link do dokumentacji SSO).
• OPCJONALNIE: ustaw xAPI – webhook Udemy do raportowania danych o postępach uczestników i zdarzeniach ukończenia kursów (dokumentacja).  Parametry dodasz na stronie ustawień administracyjnych Udemy.  Po skonfigurowaniu obejrzyj krótki wykład z maksymalną prędkością odtwarzania i sprawdź, czy otrzymasz dane o postępach.

Tworzenie oprogramowania podstawowego

Jeśli wszystkie dane logowania Udemy działąją, połączenie z wszystkimi interfejsami API zostało nawiązane, a dodatkowe konfiguracje zostały ustawione, oznacza to, że ryzyko techniczne zostało wyeliminowane.  Większość partnerów przechodzi następnie do planowania lub bezpośrednio do programowania.  Jednym ze sposobów na rozpoczęcie jest przyjrzenie się liście historii użytkowników lub obsługiwanym przypadkom użycia i zmapowanie interfejsów API Udemy potrzebnych dla każdego przypadku użycia.  Dalej wszystko zależy od Twoich inżynierów oprogramowania – życzymy powodzenia! 

Obsługa błędów, wyjątki i sprawdzone metody

Wzmocnij swoje oprogramowanie przez uwzględnienie obsługi błędów, wyjątków i przypadków brzegowych.  Aby radzić sobie z niespodziewanymi problemami informatycznymi, skorzystaj z naszych zaleceń dotyczących obsługi błędów. 

Sprawdzone metody korzystania z interfejsów API Udemy Business 

• Rejestrowanie odpowiedzi na błędy zwracane przez interfejsy API
• Dodanie logiki ponawiania prób do wywołań interfejsów API
• Radzenie sobie z limitami częstotliwości za pomocą sprawdzonych metod dotyczących rozmiaru stron
• Wdrożenie innych sprawdzonych metod zawartych w dokumencie

W celu uzyskania dodatkowego wsparcia, przekazania opinii lub po zakończeniu nowej integracji możesz skontaktować się z nami pod adresem partnersupport@udemy.com.  Cieszymy się na otwarcie nowych rynków dzięki naszym nowym wspólnym funkcjom.

Partnerzy technologiczni Udemy Business wykorzystują interfejsy API platformy do automatycznej synchronizacji kolekcji treści UB i danych aktywności uczestników z ich platformami. Integracje są dostępne tylko dla wspólnych klientów. Chcesz już rozpocząć budowanie integracji z Udemy Business? Poniżej znajdziesz dokumentację, która pomoże Ci zacząć.

• Krótkie omówienie dostępnych API
• Dokumentacja API
• Sprawdzone metody korzystania z API
• Przypadki użycia integracji przez partnerów
• Etapy integracji dla partnerów technologicznych

Poniższy przewodnik został stworzony przez Udemy jako zbiór informacji o sprawdzonych metodach dotyczących wspierania tworzenia integracji korzystających z interfejsów API Udemy Business. Zalecamy stosowanie wskazówek zawartych w tym przewodniku w celu zapewnienia jak najlepszych wrażeń użytkownikom. 

Zespół inżynierów Udemy ds. sprzedaży i rozwiązań może udzielić Ci odpowiedzi na wszelkie pytania, jakie mogą pojawić się podczas procesu integracji. 

Przewodnik, do którego link znajduje się poniżej, został opublikowany w centrum pomocy Udemy Business.

• Sprawdzone metody korzystania z interfejsów API Udemy Business

Udemy Business (UB) udostępnia trzy interfejsy RESTful API – dla kursów, ścieżek nauki i raportowania – które umożliwiają programistom programowe pobieranie katalogu kursów Udemy Business, publicznych ścieżek nauki i danych o aktywności użytkowników. Tych trzech interfejsów API można używać do integracji z aplikacją innej firmy, taką jak system zarządzania nauką (LMS). 

Uwaga: 

• interfejsy API są dostępne tylko dla klientów Enterprise.
• Dostępność tych interfejsów API nie umożliwia automatycznie integracji z LMS/LXP.
• Aby pozyskiwać dane z LMS/LXP, należy zbudować łącznik wykorzystujący te interfejsy API. Jeśli chcesz dowiedzieć się więcej, skontaktuj się z przedstawicielem ds. sukcesu klienta lub LMS/LXP.
• Dokumentacja interfejsów API jest dostępna tylko w języku angielskim.
• Aby zapoznać się z Umową licencyjna Udemy dotyczącą API, wejdź na stronę https://www.udemy.com/terms/api/
  • Uwaga: mogą obowiązywać dodatkowe lub zmienione warunki korzystania z API zależnie od umowy z klientem.
• Oprócz poniższej dokumentacji, zapoznaj się z naszym artykułem Sprawdzone metody korzystania z Udemy Business API, aby uzyskać pomocne informacje.

1. Dokumentacja interfejsów Udemy Business API – RESTful API

1. Course API
2. Learning paths API
3. Reporting API

2. Dokumentacja Udemy Business xAPI

1. xAPI obsługuje raportowanie postępów i ukończenia kursów przez uczestników w czasie rzeczywistym.