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
- Wniosek o współpracę partnerską został przesłany i zatwierdzony
- Udemy konfiguruje i udostępnia środowisko piaskownicy dla Udemy Business
- Administrator Udemy zaprasza dodatkowych uczestników
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).
- Przejrzyj pozostałe ustawienia na [Udemy Business: Zarządzaj: Ustawienia] i dopasuj je do swoich potrzeb.
Rozszerzenia
Ścieżki nauki – umożliwiają użytkownikom tworzenie programów zawierających wiele różnych zasobów edukacyjnych. Mają początek i koniec, co umożliwia wskazanie uczestnikowi kierunku rozwoju.
- 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
- Połącz się z Reporting API (learning-path-activity)
Raporty w czasie rzeczywistym przez webhooka
- Skonfiguruj 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.
Wysyłanie zapytań do danych dotyczących kursów lub przeszukiwanie tych danych – poprzez interfejs Udemy GraphQL API umożliwiamy wysyłanie zapytań do naszego katalogu kursów i otrzymywania w odpowiedzi tylko tych danych, które są Ci potrzebne do konkretnego przypadku użycia. Udostępniamy także interfejs Search API, który przyjmuje przesłane dane i filtruje oraz zwraca odpowiednie wyniki dotyczące kursów.
- Otrzymaj dane uwierzytelniające GraphQL API
- Wywołaj funkcję GraphQL GetAuthToken()
- Użyj tokena [authToken], aby wywołać Courses API
- Wywołaj CourseSearch API
Uwaga: aby uzyskać dostęp do dokumentacji GraphQL, trzeba mieć możliwość zalogowania się w Udemy Business. Odpowiedni adres URL zawiera subdomenę konta Udemy Twojej organizacji, po której znajduje się .udemy.com/dev-portal/api-reference/.
Przykładowo:
https://{Twoja_subdomena}.udemy.com/dev-portal/api-reference/.
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.
- 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.