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.