Integrationen – API und Unternehmens-Webdienste verwalten (Systemadministration)
INHALTSVERZEICHNIS
- Einführung
- 1 Übersicht
- 2 API verwalten
- 3 Informationen zur Organisations-API
- 4 IMS Enterprise-Webdienste verwalten
- 5 Informationen zu IMS Enterprise Services
- 6 Planung einer neuen Integration
Einführung
Die Systemadministration kann den API-Zugriff und Integrationen über IMS Enterprise Web Services direkt über das Administrationsmenü verwalten. Mit diesen Werkzeugen können externe Systeme Daten mit itslearning austauschen, beispielsweise um Lernwerkzeuge zu entwickeln, Inhalte einzubetten oder bestehende Anwendungen in die Plattform zu integrieren.
Voraussetzung: Eine von der Systemadministration konfigurierte Site-Profileinstellung ist erforderlich, um Zugriff auf Administration > API verwalten und IMS Enterprise-Webservices verwalten zu erhalten.
1 Übersicht
Im Administrationsmenü stehen zwei zusammengehörige Verwaltungsbereiche zur Verfügung:
| Bereich | Zweck |
|---|---|
| API verwalten | Aktiviert oder deaktiviert den API-Zugriff für die Site. |
| Unternehmens-Webdienste verwalten | Fügt Integrationen hinzu oder entfernt sie und zeigt Integrationsprotokolle an. |
IMS Enterprise Web Services werden von einigen Schülerverwaltungssystemen (SIS) verwendet, um Nutzende und Gruppen mit dem LMS und anderen Systemen zu synchronisieren.
Hinweis: Die technische Dokumentation für Entwicklerinnen und Entwickler finden Sie unter https://developer.itslearning.com/.
2 API verwalten
In diesem Bereich des Administrationsmenüs können Sie den API-Zugriff für Ihre Site aktivieren oder deaktivieren.

3 Informationen zur Organisations-API
Die Organisations-API besteht aus einer Reihe von Webdiensten, die dafür entwickelt wurden, große Mengen an Nutzerdaten aus externen Systemen nach itslearning zu übertragen. Der häufigste Anwendungsfall besteht darin, Benutzerdaten wie Dateien sowie kursspezifische Daten wie IMS-Pakete, Tests, Links und Aufgaben von einer bestehenden Plattform nach itslearning zu migrieren.
Für den Großteil der Inhalte handelt es sich dabei um eine Einwegmigration: Nachdem die Daten nach itslearning übertragen wurden, können sie nicht mehr über die API abgerufen oder geändert werden. Für einige Anwendungen, beispielsweise Stundenplan-, Bewertungs- oder Archivierungssysteme, kann dieselbe API jedoch verwendet werden, um Daten aus itslearning auszulesen und zu aktualisieren. Dadurch können Daten fortlaufend synchronisiert und aktuell gehalten werden.
3.1 Unternehmens-Webdienste der API
| Dienst | Funktion |
|---|---|
| DataService.svc | Der zentrale Dienst für die Kommunikation mit itslearning. Er verarbeitet alle asynchronen Nachrichten (AddMessage), gibt verfügbare Nachrichtentypen zurück (GetMessageTypes), meldet den Status wartender Nachrichten (GetMessageResult) und listet unterstützte Erweiterungen auf (GetExtensions). |
| ReadDataService.svc | Verarbeitet alle Lesebefehle synchron, sodass Daten in Echtzeit aus itslearning ausgelesen werden können. |
| FileService.svc | Lädt eine einzelne Datei in einen temporären Speicherbereich für Inhaltsimporte hoch und gibt eine eindeutige Kennung zurück, die in späteren Nachrichten verwendet werden kann. |
Die Organisations-API unterstützt sowohl die synchrone als auch die asynchrone Verarbeitung von Nachrichten. Asynchrone Nachrichten werden in der Reihenfolge ihres Eingangs verarbeitet, jedoch nicht zwangsläufig sofort. Das System ist – abgesehen von geplanten Wartungsfenstern – grundsätzlich rund um die Uhr verfügbar.
3.2 Zugriff auf die Organisations-API erhalten
Der Zugriff auf die Organisations-API wird durch das lokale oder globale Services-Team von itslearning eingerichtet, das gemeinsam mit Partnern die erforderlichen Zugänge konfiguriert:
- Es wird abgestimmt, welche Methoden (Organisationsdienste) benötigt werden. Der Zugriff kann bis auf Ebene einzelner Nachrichtentypen eingeschränkt werden.
- Das Mitglied des Services-Teams füllt ein Autorisierungsformular aus, um den Zugriff einzurichten.
- Das Services-Team stellt dem Partner einen eindeutigen Benutzernamen und ein Kennwort für WS-Security zur Verfügung.
- Der Partner kann anschließend mit den bereitgestellten Zugangsdaten auf die freigegebenen Dienste zugreifen.
Hinweis: Die Organisations-API ist immer auf eine bestimmte Site beschränkt. Jede Kombination aus Benutzername und Kennwort ist eindeutig einem Partner und einer Site zugeordnet. Hat ein Partner Zugriff auf zwei Sites, erhält er zwei verschiedene Zugangsdaten.
4 IMS Enterprise-Webdienste verwalten
In diesem Bereich des Administrationsmenüs können Sie Integrationen hinzufügen oder entfernen sowie die Protokolle der letzten sieben Tage einsehen. Wenn Sie Protokolldaten benötigen, die älter als sieben Tage sind, oder Fragen zu Integrationen haben, die zuvor von unserem Team eingerichtet wurden, wenden Sie sich bitte an den itslearning-Support.

5 Informationen zu IMS Enterprise Services
Die Spezifikation IMS Enterprise Services, veröffentlicht vom IMS Global Learning Consortium, definiert, wie Systeme Informationen über Personen, Gruppen und Mitgliedschaften im Bildungskontext austauschen und verwalten.
itslearning unterstützt den Großteil dieser Spezifikation und erweitert sie um zusätzliche Funktionen, die standardmäßig nicht Bestandteil von IMS Enterprise Services sind. Die von itslearning nicht unterstützten Bereiche beziehen sich überwiegend auf Funktionen, die für itslearning als Lernplattform nicht relevant sind.
Die von itslearning implementierten Dienste und Methoden sind nach ihrem Hauptzweck gegliedert:
- Personen verwalten
- Gruppen verwalten
- Mitgliedschaften verwalten
Hinweis: Auf der Entwicklerseite steht eine in C# geschriebene IMS-ES-Vorlage zum Download bereit. Sie dient als Wrapper für das allgemeine IMS-ES-Framework und verwendet ausschließlich die Teile, die in itslearning tatsächlich genutzt werden.
5.1 Dienstzugriff und Umgebungen
Um Zugriff auf eine Entwicklungsumgebung zu erhalten, müssen Sie lizenzierter Kunde oder Integrationspartner sein. Wenden Sie sich für weitere Informationen an Ihr lokales itslearning-Team.
| Umgebung | Basis-URL | Zugänglich für |
|---|---|---|
| Testserver (stabil) | https://enterprise.itslintegrations.com/WCFServiceLibrary/ImsEnterpriseServicesPort.svc | Kunden und Systemintegrationspartner für die Dauer des Implementierungsprojekts |
| Produktivserver AWS (EU) | https://eu1enterprise.itslearning.com/WCFServiceLibrary/ImsEnterpriseServicesPort.svc | Lizenzierte Kunden in Europa und weltweit |
6 Planung einer neuen Integration
Planen Sie eine neue Integration mit itslearning oder möchten Sie weitere Anwendungen anbinden und benötigen dabei Unterstützung? Wenden Sie sich bitte an Ihre zuständige Ansprechperson im Account Management.
Weitere Hilferessourcen
Haben Sie weitere Fragen? Wenden Sie sich zunächst an Ihre Schuladministration.
Hinweise zu Produktveröffentlichungen
Bleiben Sie über die neuesten Veröffentlichungen von itslearning informiert: https://itslearning.com/product-updates
Servicestatus
Prüfen Sie den aktuellen Status der itslearning-Dienste: https://status.itslearning.com/
Ideenportal
Teilen Sie Ihre Ideen und gestalten Sie die Zukunft von itslearning mit: https://ideas.itslearning.com/
Roadmap
Werfen Sie einen Blick auf unsere Roadmap: https://itslearning.com/global/roadmap/
