Schnelleinstieg Quellsysteme

Schulconnex definiert und spezifiziert zwei unterschiedliche APIs, eine Dienste-API und eine Quellsysteme-API.

Die Quellsystem-API dient der Bereitstellung, dem Austausch und der Synchronisation von Identitäten und Kontextdaten zwischen schulischen Identitätsmanagementsystemen. Die Quellsystem-API erlaubt lesenden und schreibenden Zugriff auf Informationen.

Die Dienste-API dient primär der Bereitstellung von Kontextinformationen zur Anmeldung von Nutzern an externe Dienste. Die Dienste API stellt nur einen lesenden Zugriff auf Information bereit.

Das Kapitel Datenmodelle spezifiziert dabei sämtliche verfügbare Datenmodelle zur Nutzung der jeweiligen API.

Viele der verwendeten Attribute können nur Werte aus fest definierten Codelisten annehmen. Diese sind im Kapitel Codelisten spezifiziert.

Das Kapitel „English API Notes“ stellt eine Beschreibung der Attribute und Codelisten in englischer Sprache bereit. Diese Kapitel stellt keine englische Übersetzung der Spezifikation dar, sondern soll dazu dienen, Entwicklern, deren Muttersprache nicht Deutsch ist, das Verständnis von Begriffen zu erleichtern, welche bei automatischer Übersetzung leicht fehlübersetzt werden.

Die eigentliche REST-API ist jeweils für Dienste und Quellsysteme im OpenAPI-Format spezifiziert und steht sowohl als Webseite als auch zum Herunterladen im OpenAPI-YAML-Format zur Verfügung.

Quellsystem-API

Das Kapitel zur Nutzung der REST-API erläutert allgemein den Zugriff auf Resourcen, die Schulconnex-spezifischen Fehlercodes und den Validierungsprozess bei Anfragen an die REST-API sowie den Autorisierungsvorgang gegenüber einem Schulconnex-Server.

Ein nichtnormativer Praxisleitfaden für die Implementierung beschreibt exemplarisch empfohlene Vorgehensweise einiger typischer Abläufe, wie ein Schuljahreswechsel oder das Löschen von Personenkontexten und Personen.