Dokumentation & Support-Leitfäden

Die Udemy Business-APIs bieten verschiedene Arten von Integrationsfunktionen, die eine flexiblere Softwareentwicklung ermöglichen.  Dieser Artikel beschreibt einige der Anwendungsmöglichkeiten für die einzelnen APIs und gibt dir Empfehlungen zur Auswahl.

• Informiere dich über die von Udemy unterstützten Anwendungsmöglichkeiten für die Partnerintegration.

Inhalt

• Kurse und alle Lernobjekte
• Berichte
• Lernpfade
• SSO (Single Sign-On)
• Kurs-API (veraltet)
• Empfohlene optimale Integration

Kurse und alle Lernobjekte

GraphQL-Kurs-API – Protokoll: GraphQL 

• Die Weiterentwicklung der herkömmlichen Kurs-API. In GraphQL ist es für jeden Kurs möglich, nur die angegebenen Kurs-Metadaten abzurufen. Außerdem können über das Abfragesystem von GraphQL Kurse zurückgegeben werden, die den angegebenen Kriterien entsprechen. 

Hinweis: Weitere Informationen zur allgemeinen Technologie hinter GraphQL findest du auf der GraphQL-Website.

GraphQL-API für alle Lernobjekte – Protokoll: GraphQL 

• Udemy bietet neben Kursen noch weitere Lernformate.  Alle Lernobjekte werden über eine API für die Integration in dein System bereitgestellt.  Mit dieser API kannst du Kurse, Labs und Badges abrufen.  Wie bei den anderen GraphQL-Diensten auch hast du die Möglichkeit, mithilfe von Abfragen nur die angegebenen Objekte und Felder abzurufen.

Dokumentation:  Für den Zugriff auf die GraphQL-Dokumentation musst du auf Udemy Business zugreifen können. Das Entwicklerportal findest du unter der folgenden URL: https://{deine_subdomain}.udemy.com/dev-portal/api-reference/

Berichte

Berichts-API – Protokoll: RESTful 

• Diese API enthält alle erfassten Nutzerdaten zu Fortschritt, Abschlüssen und Lernaktivitäten.  Du kannst entweder alle Nutzerberichtsdaten abrufen oder bestimmte Nutzer angeben. Aufgrund der Datenmenge werden die Nutzeraktionen in den Berichten mit einer leichten Verzögerung erfasst.

Dokumentation: Dokumentation der Udemy Business-API – RESTful-APIs

xAPI – Protokoll: xAPI

• Berichtsdaten in Echtzeit, Übermittlung erfolgt über einen Webhook, nach xAPI-EdTech-Standards entwickelt.  Udemy ermöglicht die Push-Übermittlung von Fortschritts- und Berichtsdaten in Echtzeit.  Der Datenumfang in diesen Echtzeitereignissen ist geringer als bei der RESTful-Berichts-API.

Dokumentation: Dokumentation der Udemy Business-xAPI

Lernpfade

Lernpfad-API – Protokoll: RESTful 

• Udemy bietet Nutzer:innen und Weiterbildungsadministrator:innen die Möglichkeit, Lernpfade zu erstellen, d. h. eine Zusammenstellung verschiedener Kurse, die mit anderen Lernobjekten oder sogar externen Links kombiniert werden. Wir stellen diese Lernpfade über eine API bereit und geben alle Lernpfade einschließlich der darin enthaltenen Elemente zurück.

Dokumentation: Dokumentation der Udemy Business-API – RESTful-APIs

SSO (Single Sign-On)

Udemy Business kann eine Verbindung mit allen SAML 2.0-SSO-Diensten herstellen, d. h. mit den meisten SSO-Anbietern. Darüber hinaus sind auch benutzerdefinierte SSO-Integrationen verfügbar, solange sie dem SAML 2.0-Standard entsprechen.

Protokoll: SAML 2.0 (und höher)

Dokumentation: Überblick über die wichtigsten SSO-Funktionen bei Udemy Business

SCIM-Nutzerbereitstellungs-APIs – Über die SCIM-Bereitstellung (System for Cross-domain Identity Management) kannst du Nutzerlizenzen bereitstellen und die Bereitstellung wieder aufheben. Mit diesem System können deine IT-Teams oder individuell angepasste Integrationen die Lizenzverwaltungsfunktionen automatisieren.

Protokoll: SCIM

Dokumentation: ​​SCIM-Bereitstellung (System for Cross-domain Identity Management)

Kurs-API (veraltet) 

Kurs-API – Protokoll: RESTful 

• Die Kurs-API wurde nach herkömmlichen EdTech-Standards entwickelt. Sie ruft alle Kurs-Metadaten für einen einzelnen Kurs oder für alle Kurse ab.

Hinweis: Diese Kurs-API ist inzwischen veraltet. Wir veröffentlichen keine neuen Funktionen mehr für diese API.  Alle neuen Funktionen werden in den GraphQL-APIs veröffentlicht, die nicht nur Kurse, sondern alle Lernobjekte enthalten.

Dokumentation: Dokumentation der Udemy Business-API – RESTful-APIs

Empfohlene optimale Integration

Die Kunden und Partner von Udemy sind sehr unterschiedliche und können entsprechend unterschiedliche Anforderungen haben. Für eine optimale Integration empfehlen wir die Einbindung folgender APIs:

1. Kurse und Lernobjekte: Nutze die GraphQL-API für Zugriff auf alle Lernobjekte.

2. Berichte: Nutze die REST-API für den vollen Datenumfang und ergänze dies durch die xAPI für Echtzeitdaten.

3. SSO: Sollte in Verbindung mit SCIM verwendet werden, um die Nutzerbereitstellung und die Aufhebung der Bereitstellungen zu automatisieren.

4. Lernpfade: Nutze die Lernpfad-API, damit Weiterbildungsadministrator:innen und Programmleiter:innen Lernpfade für die Endnutzer:innen erstellen können.

Udemy Business – Leben durch Lernen verbessern

Durch Einbindung der Udemy-Weiterbildungs-Engine kannst du Lerninhalte für die berufliche Weiterentwicklung über vielfältige Konnektivitätslösungen und benutzerfreundliche Apps in deinen Netzwerken und Ökosystemen bereitstellen, sodass deine Mitarbeiter über deine Onlineplattformen und -services auf die Udemy-Weiterbildungsservices zugreifen können. 

Udemy Business bietet Tausende von Kursen, die kontinuierlich ergänzt und aktualisiert werden und damit thematisch und inhaltlich immer auf dem allerneuesten Stand sind (unsere Weiterbildungs-Engine).  Die hochwertigen, top-aktuellen Onlinekurse zu gefragten Themen wie Programmierung, Business-Skills, persönliche Weiterentwicklung und vielem mehr unterstützen die Nutzer beim Erreichen ihrer persönlichen und beruflichen Ziele.

Durch die Integration von Udemy Business kannst du deinen Nutzern die Suche und Entdeckung von top-bewerteten Udemy Business-Kursen (und Lernpfaden) auf unserer Plattform und die Wiedergabe über den Udemy-Player ermöglichen. 

Inhalt:

Anwendungsfall 1: Content-Integration

Wichtigste Vorteile:

Anwendungsfall 2: Nutzerfortschritts- und Analysedaten

Wichtigste Vorteile:

Zeitplan und Meilensteine für die Integration

Überblick über die Architektur

Eine Udemy Business-Integration ermöglicht die beiden folgenden grundlegenden Anwendungsfälle: 

Anwendungsfall 1: Content-Integration

Die Content-Integration erweitert den Zugang zu Udemy Business-Online-Lernangeboten (d. h. Kurse und Lernpfade) und ergänzt damit dein Online-Serviceangebot.  Mit einer Udemy Business-Content-Integration können unsere Partner die Suche und Entdeckung von Udemy Business-Onlinekursen und Lernpfaden (strukturierte Lernziele) direkt in ihren eigenen Web- und/oder Mobile-Apps bereitstellen.  Deine Nutzer können dann den kuratierten Udemy-Content (oder Lernpfade) in einem vertrauten System entdecken und nutzen.  Eine Udemy Business-Content-Integration bietet den Nutzern (und Partnern) den Vorteil einer nahtlosen Schnittstelle mit der Website und den Services des Partners.  Die Content-Integration funktioniert über moderne Web-Services (APIs), die die Verbindung mit unserer leistungsstarken Online-Weiterbildungs-Engine herstellen.  Udemy unterstützt seine Partner durch den Content-Integration-Connector. Dies umfasst auch Anleitungen für das Lifecycle-Management sowie zum Erstellen, Testen und Bereitstellen des Connectors für die Webanwendung oder Mobile-App des Partners. 

Wichtigste Vorteile:

• Zugriff auf aktuellen Online-Lern-Content für die berufliche und persönliche Weiterentwicklung, direkt über deine eigenen Webanwendungen und Mobile-Apps
• Intensivere Nutzung, da aufgrund der nahtlosen, automatisierten Synchronisierung immer aktuelle Inhalte verfügbar sind
• Die Nutzer finden sich dank der intuitiven Suche und Entdeckung leicht im Content zurecht
• Überwachung des Lernfortschritts fast in Echtzeit und Unterstützung der Mitarbeiterentwicklung
• Einfacher und sicherer Zugang über SSO (Single Sign-On)
• Auch unterwegs bequem über deine eigenen Webanwendungen und Mobile-Apps lernen

Anwendungsfall 2: Nutzerfortschritts- und Analysedaten

Du kannst durch die Integration der Udemy Business-Nutzerdaten detaillierte Erkenntnisse über das Lernverhalten und die Lernbedürfnisse deiner Nutzer gewinnen. Dank der Einbeziehung von Daten zur Kursnutzung, zum Lernfortschritt und zu den Kursabschlüssen in deine Analysen kannst du das Lernerlebnis immer besser auf die individuellen Anforderungen der Nutzer abstimmen und essenzielle Lernkonzepte anbieten (z. B. gezielte Lernpfade).  Für die Nutzungsanalyse werden umfangreiche Nutzungssignaldaten ausgewertet, sodass unsere Partner anhand von kombinierten Daten Lernmuster herausarbeiten können, um das Lernerlebnis für die Nutzer kontinuierlich zu optimieren. 

Wichtigste Vorteile:

• Entwicklung kombinierter Nutzungsanalysen zur Erkennung wichtiger Signale in den Lernbedürfnissen deiner Nutzer
• Maßgeschneiderte Anpassung von Udemy Business-Content an die jeweilige Zielgruppe auf Basis der Analysedaten
• Erweiterung der Serviceangebote mithilfe von künstlicher Intelligenz zur Ermittlung der spezifischen Anforderungen und Interessen deiner Nutzer
• Fortlaufende Messung und Weiterentwicklung der Lernangebote, um ein umfassendes Lernerlebnis und die Bündelung verschiedener Services zu bieten

Entdecke das Partner-Ökosystem von Udemy, das auf den Udemy Business-Services und unserer leistungsstarken Udemy-Weiterbildungs-Engine beruht. 

Zeitplan und Meilensteine für die Integration

Die Planung, Entwicklung und Bereitstellung eines API-basierten Connectors für die oben genannten Anwendungsfälle dauert bei unseren Partnern durchschnittlich vier Wochen .  Udemy Business stellt einen Experten für die Connector-Entwicklung zur Verfügung, der den Partnern mit Rat und Tat zur Seite steht, um die Integration mit den Udemy-APIs zu optimieren. 

Überblick über die Architektur

Die wesentlichen Bestandteile der Integration sind unten abgebildet.  Die Datensynchronisierung erfolgt über die Udemy Business-APIs und wird vom Partner-Connector orchestriert.  Die Suche und Erkennung von Udemy-Kursen und Lernpfaden funktioniert über den Connector direkt auf den Webanwendungen und Mobile-Apps des Partners. 

Wenn die optionale SSO-Funktion (Single Sign-On) aktiviert wird, können sich die Nutzer direkt über die Lernplattform des Partners nahtlos mit einer Udemy Business-Website verbinden. 

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

• Rechtliche Vereinbarungen sind unterzeichnet
• Udemy stellt Umgebung für Udemy Business bereit
• Einladung zur Udemy-Anmeldung

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)
• OPTIONAL 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.

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.

Die Technologiepartner von Udemy Business nutzen unsere Plattform-APIs für die automatisierte Synchronisierung des Udemy Business-Content-Katalogs und der Nutzeraktivitätsdaten. Integrationen sind nur bei einer gegenseitigen Kundenbeziehung verfügbar. Du möchtest eine Integration mit Udemy Business erstellen? Die folgende Dokumentation hilft dir beim Einstieg.

• Übersicht über die verfügbaren APIs
• API-Referenz
• Guide zur Nutzung der APIs
• Anwendungsfälle für die Partnerintegration
• Integrationsschritte für Technologiepartner

Der unten verlinkte Guide wurde von Udemy erstellt. Er beschreibt bewährte Vorgehensweisen und möchte dich bei der Integrationsentwicklung unter Verwendung der Udemy Business-APIs unterstützen. Wir empfehlen dir, die enthaltenen Tipps und Hinweise umzusetzen, um deinen Endnutzern ein rundum optimales Lernerlebnis zu bieten. 

Falls bei der Entwicklung Fragen aufkommen, hilft dir unser Sales & Solutions Engineering-Team gern weiter. 

Hinweis: Der hier aufgeführte und verlinkte Guide befindet sich im Hilfe-Center von Udemy Business.

• Guide zu den Udemy Business-APIs

Udemy Business (UB) bietet drei RESTful-APIs (für Kurse, Lernpfade und Berichte), die es Entwicklern ermöglichen, den Udemy Business-Kurskatalog, öffentliche Lernpfade und die Daten zu den Kursaktivitäten der Nutzer programmgesteuert abzurufen. Diese drei APIs können zur Integration in Anwendungen anderer Hersteller verwendet werden, beispielsweise in ein Lernmanagement-System (LMS).

Hinweis: 

• APIs sind nur für Kunden mit einem Enterprise-Abo verfügbar.
• Die Verfügbarkeit dieser APIs aktiviert nicht automatisch die Integration in ein LMS/LXP.
• Zur Erfassung der Daten in einem LMS/LXP muss mithilfe dieser APIs ein Connector erstellt werden. Wenn du mehr darüber erfahren möchtest, kontaktiere bitte deinen Customer-Success- oder LMS/LXP-Ansprechpartner.
• Die API-Dokumentation ist nur auf Englisch verfügbar.
• Die Udemy-API-Lizenzvereinbarung findest du unter: https://www.udemy.com/terms/api/
  • Hinweis: Je nach dem Vertrag, der mit dem Kunden abgeschlossen wurde, können zusätzliche oder abweichende Nutzungsbedingungen für die API gelten.
• Weitere Informationen findest du in der folgenden Dokumentation sowie in unserem Guide zu den Udemy Business-APIs.

1. Dokumentation der Udemy Business-API – RESTful-APIs

1. Kurs-API
2. Lernpfad-API
3. Berichts-API

2. Dokumentation der Udemy Business-xAPI

1. Die xAPI unterstützt die Meldung von Nutzerfortschritten und Kursabschlüssen in Echtzeit.