Zielsetzung der API

Der SVWS-Server stellt eine REST-API bereit, die in erster Linie der Kommunikation zwischen den landeseigenen Anwendungen SchILD-NRW 3 und SVWS dient.

Darüber hinaus existiert eine versionierte Integrationsschnittstelle für Lernplattformen und vergleichbare Systeme, über die die für Benutzerverwaltung und Schulorganisation erforderlichen Stammdaten automatisiert ausgetauscht werden können.

Diese Schnittstelle stellt den derzeit vorgesehenen Integrationsumfang für externe Softwareanbieter dar.

Keine allgemeine Entwicklungsplattform für Drittsoftware

Die Entwicklung des SVWS-Servers erfolgt im Auftrag des Ministeriums für Schule und Bildung des Landes Nordrhein-Westfalen zur Unterstützung der landeseigenen Schulverwaltungssoftware.

Die API ist keine generische Herstellerplattform für kommerzielle Drittsoftware.

Insbesondere erfolgt

• keine Entwicklung individueller API-Endpunkte,
• keine Priorisierung von Anforderungen einzelner Softwareanbieter,
• keine Beratung bei der Architektur oder Implementierung von Drittsoftware,
• keine Unterstützung bei der Entwicklung von REST-Clients,
• keine Bewertung individueller Integrationskonzepte,
• keine Freigabe oder Zertifizierung von Drittsoftware.

Die vorhandene Dokumentation sowie die bereitgestellten Testsysteme stellen den vollständigen Umfang des Herstellersupports für externe Anbieter dar.

Unterstützte Schnittstellen

Für Drittanbieter sind ausschließlich die versionierten External-Endpunkte vorgesehen.

Diese Schnittstellen dienen dem Austausch allgemeiner Stammdaten (z. B. Benutzer, Klassen, Kurse oder Gruppen) mit Lernplattformen und vergleichbaren Systemen.

Nur diese Schnittstellen werden hinsichtlich ihrer langfristigen Stabilität versioniert gepflegt.

Andere API-Endpunkte dienen ausschließlich der internen Kommunikation zwischen SchILD-NRW 3, dem SVWS-Server sowie weiteren landeseigenen Komponenten und sind nicht Bestandteil einer öffentlichen Integrationsschnittstelle.

Aus der Existenz einzelner Endpunkte im Quellcode oder in der API-Dokumentation kann daher keine Freigabe für den produktiven Einsatz durch Drittsoftware abgeleitet werden.

Keine Unterstützung für Fachverfahren

Eine Anbindung externer Software an interne Fachverfahren der Schulverwaltung ist derzeit nicht vorgesehen.

Dies betrifft insbesondere den produktiven Schreibzugriff auf

• Leistungsdaten,
• Quartals- und Zeugnisnoten,
• Teilleistungen,
• Bemerkungen,
• Fehlstunden,
• Lernabschnittsdaten,
• Prüfungsdaten sowie weitere pädagogische Verwaltungsdaten.

Ebenso werden hierzu keine Aussagen über

• interne DTOs,
• Synchronisationsmechanismen,
• Berechtigungsmodelle,
• Sperr- und Konfliktstrategien,
• Zeitstempelverfahren,
• Auditierungsmechanismen,
• interne Entwicklungsstände,
• Snapshot- oder Entwicklungsversionen,
• zukünftige Entwicklungsplanungen oder Roadmaps

bereitgestellt.

Interne Entwicklungsarbeiten dienen ausschließlich den Anforderungen der landeseigenen Anwendungen und stellen keine Freigabe für externe Softwareprodukte dar.

Sicherheitskonzept

Der SVWS-Server wird in Schulen grundsätzlich innerhalb eines geschützten Verwaltungsnetzes betrieben.

Eine öffentlich erreichbare API ist aus Datenschutz- und Sicherheitsgründen nicht vorgesehen.

Soll eine Drittsoftware angebunden werden, muss der Datenaustausch innerhalb der Infrastruktur der jeweiligen Schule erfolgen. Die technische Umsetzung (z. B. Connector, Middleware, VPN oder Reverse Proxy) liegt in der Verantwortung des jeweiligen Softwareanbieters bzw. des Schulträgers.

Testsystem

Sie können den SVWS-Server auf einem Testclient oder -server installieren. Sie finden die aktuelle Version unter dem Link https://github.com/SVWS-NRW/SVWS-Server/releases. Eine Anleitung zur Installation finden Sie in der Dokumentation unter dem Link https://doku.svws-nrw.de/deployment/. Testdatenbanken unterschiedlicher Schulform finden Sie unter dem Link https://github.com/SVWS-NRW/SVWS-TestMDBs

API-Dokumentation

Die Dokumentation der für externe Systeme vorgesehenen REST-API erreichen Sie nach der Installation des SVWS-Servers über den Browser. Rufen Sie hierzu folgende Adresse auf:

https://{IP-Adresse des Servers}/debug/index.html?urls.primaryName=external

Open Source

Der SVWS-Server ist ein Open-Source-Projekt.

Interessierte Entwickler können den Quellcode einsehen, die technische Dokumentation nutzen und sich bei Interesse an der Weiterentwicklung beteiligen.

Für externe Integrationen empfehlen wir ausschließlich die Nutzung der dokumentierten und versionierten External-Schnittstelle.