Die Seite wird geladen...

Schnittstellen – Übersicht

Der Sammlerdienst ist für das Einsammeln und Validieren der Exporte der Redaktionssysteme von Bund und Ländern zuständig. Die Exporte der Gesamtdatenbestände der Redaktionssysteme werden dabei durch den Sammlerdienst per Pull-Verfahren aus den Redaktionssystemen abgerufen.

Seit Anfang 2022 wird eine REST-Schnittstelle entwickelt, über die die Redaktionssysteme einzelne Änderungen per Push-Verfahren an den Sammlerdienst übermitteln können.

Bitte beachten: Der Zugriff auf die Push-Schnittstelle erfordert eine Autorisierung gegenüber der Benutzerverwaltung des PVOG.

Versionierung der Schnittstelle

Um bestmögliche Kompatibilität zu gewährleisten, ist in allen Diensten eine Schnittstellenversionierung umgesetzt, sodass externe Konsumenten in einem selbstbestimmten Tempo auf die neuen Schnittstellenversionen migrieren können. Hierfür wird die Versionsnummer des Pfades inkrementell erhöht, die vorherige Schnittstelle als deprecated deklariert und die Dokumentation der Schnittstelle entsprechend angepasst. Die Versionierung erfolgt über eine Versions-Komponente (z.B. v1, v2, …) des Pfads einer jeden externen Schnittstelle.

Neue Schnittstellenversionen können jederzeit mit einem PVOG-Release veröffentlicht werden. Die alten, als deprecated markierten Schnittstellen bleiben für die Übergangszeit bestehen, während parallel die neuen Schnittstellen in allen Umgebungen bereitstehen, um die Anpassung der Anbindung auf Konsumentenseite nach deren Tempo zu ermöglichen. Die Schnittstellen, die als deprecated markiert sind, werden nach einer Übergangszeit von min. drei Monaten entweder zum 01.02., 01.05., 01.08. oder 01.11. dauerhaft deaktiviert und sind somit nicht mehr nutzbar.