Schnelleinstieg Dienste
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.
Dienste-API
Das Kapitel zu Datenmodellen ist als Beschreibung der maximal verfügbaren Informationen zu sehen. Im Einzelfall vereinbart jeder Dienstanbieter mit dem Betreiber eines Schulconnex-Servers vertraglich, welche der definierten Attribute für den Betrieb des Dienstes notwendig sind. Zur Wahrung des Grundsatzes der Datensparsamkeit werden dann nur die vereinbarten Attribute und Werte an der Schnittstelle bereitgestellt.
Das Kapitel API-Autorisierung und Authentifikation für Dienstanbieter beschreibt die Nutzung der REST-API zum Zugriff auf die Informationen, sowie die Möglichkeit, Anmeldeinformationen teilweise auch in OIDC Claims zu liefern.