Kurzanleitung für die Integration
Es ist in unser beider Interesse, die Integration zügig umzusetzen, damit wir so schnell wie möglich neue Märkte für unsere gemeinsamen Kunden erschließen können.
Udemy Business-Integrationsseite, siehe die folgende Abbildung
Voraussetzungen
- Bewerbung für eine Partnerschaft wurde eingereicht und genehmigt.
- Udemy stellt Sandbox-Umgebung für Udemy Business bereit.
- Udemy-Administrator:in lädt weitere Nutzer:innen ein.
Sollte eine dieser Voraussetzungen noch nicht erfüllt sein, findest du alle entsprechenden Informationen im Guide zum Einstieg.
Anwendungsfälle für die Partnerintegration: Hier kannst du dich über die allgemeinen Anwendungsfälle informieren, auf die sich diese Integrationsschritte beziehen. Wenn du damit schon vertraut bist, geht es jetzt mit der Entwicklung weiter.
Entwicklungsschritte
Um das technische Risiko möglichst gering zu halten, empfehlen wir, zunächst eine Verbindung mit allen Udemy-APIs herzustellen und erst dann mit der Softwareentwicklung zu beginnen, nachdem bestätigt wurde, dass alle Endpunkte funktionieren.
- Verbindung mit der Kurs-API herstellen, mindestens 10 Kurse abrufen
- Verbindung mit der Kurs-API herstellen, 1 Kurs abrufen
- Bei der Udemy Business-Website anmelden, dich in einen Kurs einschreiben, mindestens 1 Minute lang eine Lektion ansehen (du kannst die Wiedergabegeschwindigkeit erhöhen)
- Verbindung mit der Berichts-API herstellen (user-activity)
- Verbindung mit der Berichts-API herstellen (user-course-activity)
- Verbindung mit der Berichts-API herstellen (learning-activity-attempt)
- Bei der Udemy Business-Website anmelden und einen Lernpfad erstellen (Dokumentation), einen Kurs öffnen und diesen Kurs in den soeben erstellten Lernpfad aufnehmen
- Verbindung mit der Lernpfad-API herstellen, den soeben erstellten Lernpfad abrufen
Konfigurationen
Wenn die Mehrzahl dieser APIs funktioniert, kannst du mit den Konfigurationsschritten fortfahren.
- SSO (Single Sign-On) wird direkt auf der Udemy Business-Einstellungsseite konfiguriert. Zum Aufrufen dieser Einstellungen benötigst du Administratorberechtigungen. Richte eine vorkonfigurierte SSO-Option mit einem unserer vielen Anbieter ein oder erstelle eine benutzerdefinierte Verbindung mit SAML 2.0. (Link zu SSO-Dokumentation)
- Lege die weiteren Einstellungen in Udemy Business unter „Verwalten > Einstellungen“ nach deinen Bedürfnissen fest.
Verbesserungen
Lernpfade: Ermöglicht es den Nutzer:innen, einen Lernplan mit einer breiten Auswahl von Lernmaterialien zu erstellen, in denen die Lerner:innen gezielt durch das Thema geführt werden
- Bei der Udemy Business-Website anmelden und einen Lernpfad erstellen (Dokumentation), einen Kurs öffnen und diesen Kurs in den soeben erstellten Lernpfad aufnehmen
- Verbindung mit der Lernpfad-API herstellen, den soeben erstellten Lernpfad abrufen
- Verbindung mit der Berichts-API herstellen (learning-path-activity)
Echtzeitbericht über einen Webhook
- xAPI einrichten: Dies ist der Udemy-Webhook für die Übermittlung von Daten zum Nutzerfortschritt und zu Abschlussereignissen (Dokumentation). Du musst Parameter auf Udemy-Administrationseinstellungsseite eingeben.
- Schau dir nach der Einrichtung eine kurze Lektion bei maximaler Wiedergabegeschwindigkeit an, um zu prüfen, ob die Fortschrittsdaten empfangen werden.
Kursdaten abfragen oder suchen: Über die GraphQL-API von Udemy kann unser Kurskatalog abgefragt werden, wobei nur die für den jeweiligen Anwendungsfall benötigten Daten zurückgegeben werden. Darüber hinaus ist eine Such-API verfügbar, die deine Eingaben und Filter annimmt und die entsprechenden Kursergebnisse zurückgibt.
- GraphQL-API-Anmeldedaten beschaffen
- GraphQL-Funktion „GetAuthToken()“ aufrufen
- Kurs-API mithilfe von „authToken“ aufrufen
- Such-API für Kurse aufrufen
Hinweis: Für den Zugriff auf die GraphQL-Dokumentation musst du bei Udemy Business angemeldet sein. Die entsprechende URL enthält die Subdomain des Udemy-Unternehmenskontos, gefolgt von „.udemy.com/dev-portal/api-reference/“.
Beispiele:
https://{deine_subdomain}.udemy.com/dev-portal/api-reference/
Basissoftwareentwicklung
Wenn alle Udemy-Anmeldeinformationen funktionieren, Verbindungen mit allen APIs bestehen und weitere Konfigurationen vorgenommen wurden, besteht kein technisches Risiko mehr. Die meisten Partner beginnen nun mit der Planung oder direkt mit der Entwicklung. Du kannst beispielsweise einer Liste mit User-Storys oder unterstützten Anwendungsfällen jeweils die erforderlichen Udemy-APIs zuordnen. An dieser Stelle geht ein Gruß an deine Softwareentwickler raus!
Fehlerbehandlung, Ausnahmen und bewährte Verfahren
Du solltest zur Härtung der Software Fehlerbehandlung, Ausnahmen und Randfälle einschließen. Zur Behandlung von unerwarteten IT-Problemen bieten wir eine Reihe von Empfehlungen zur Fehlerbehandlung.
Guide zu den Udemy Business-APIs
- Von den APIs zurückgegebene Protokollfehlermeldungen
- Wiederholungsroutinen zu den API-Aufrufen hinzufügen
- Abrufratenlimits mithilfe von „page_size“-Routinen behandeln
- Die weiteren im Dokument erläuterten bewährten Verfahren umsetzen
Wenn du weitere Unterstützung benötigst, uns Feedback geben willst oder deine neue Integration abgeschlossen hast, kontaktiere uns bitte unter partnersupport@udemy.com. Wir freuen uns darauf, mit unserer neuen Kooperation gemeinsam neue Märkte zu erschließen.