Import-API (Umsystem als Datenlieferant)

Geändert am: Do, 22 Aug, 2024 um 10:41 VORMITTAGS

Dieser Artikel behandelt die technischen Möglichkeiten unserer generischen Import-Schnittstelle/API.
Zielgruppe: Interessierte Anbieter von Umsystemen, für welche es noch keinen spezifischen Import-Adapter gibt.

Unsere Import-Schnittstelle bietet grundsätzlich die Mögllichkeit, jegliche Daten von Umsystemen automatisiert zu importieren. Häufig wird die Anbindung an fremden Stammdaten-System gewünscht, in welchem beispielsweise die zentrale Verwaltung des Personals oder der Schülerinnen und Schüler geführt wird. Damit diese Daten nicht doppelt geführt werden müssen, bieten wir die Möglichkeit einer Schnittstelle. Zu Edis, CMI Schule, CMI iCampus oder CMI Scolaris bieten wir Standard-Schnittstellen an, zu Abacus Lösungen ist in jedem Fall die Entwicklung eines spezifischen Adapters in Zusammenarbeit mit dem Abacus-Partner der Schule notwendig, zum AD von Microsoft gibt es auch standardisierte Schnittstellen. Je nach Use-Case und Möglichkeiten des Umsystems können die Daten vom Umsystem im gewünschten Format (bspw. JSON, XML, CSV) aufbereitet werden und via Push durch das Umsystem oder Pull von Escola abgeholt werden.

6.1 Push

Das Umsystem liefert die Daten periodisch an Escola. Der zeitlichen Rhythmus der Lieferung wird mit Escola vereinbart. Jede Lieferung wird protokolliert, auch das gesendete Datenpaket wird als Archiv gespeichert und erst nach 30 Tagen gelöscht. Der Endpoint ist entweder ein SFTP-Server, den Escola oder das Umsystem zur Verfügung stellt oder eine https-URL von Escola. Falls die Daten an eine URL gesendet werden, wird vorgängig mit dem Umsystem eine ClientId und ein Secret ausgetauscht, um eine sichere Übertragung zu gewährleisten.

6.1 Pull

Escola kann via eine API auf die Daten des Umsystems zugreiffen, um die Daten periodisch abzuholen. Vorgängig wird mit dem Umsystem ein Authentifizierungs-Mechanismus ausgemacht, damit eine sichere Übertragung gewährleistet ist. Jeder Zugriff von Escola auf das Umsystem wird von Escola protokolliert, auch das abgeholte Datenpaket wird als Archiv gespeichert und erst nach 30 Tagen gelöscht.

Lesen Sie folgenden Artikel, falls Sie als Umsystem ein interessierter Datenempfänger sind: Exporte & Synchronisationen