Die Kernaufgabe des Bereitstelldienstes ist die Bereitstellung einer Schnittstelle zum Abruf und zur Aktualisierung des gesamten Datenbestandes des Portalverbund Online-Gateways. Der Bereitstelldienst erhält vom Sammlerdienst die validierten Daten im XZuFi 2.2 Format und bereitet diese für eine referenzkonsistente Auslieferung auf.

Der Bereitstelldienst stellt eine REST Schnittstelle bereit, über die sowohl der Gesamtdatenbestand als auch Aktualisierungen seit dem letzten Aufruf, abgerufen werden können. Zusätzlich ist es möglich den Datenabruf auf einen Teil des Gesamtdatenbestandes durch die Angabe von Amtlichen Regionalschlüsseln und/oder Mustern zu beschränken.

Bitte beachten: Die Schnittstelle des Bereitstelldienstes ist nicht öffentlich, sondern erfordert eine Autorisierung gegenüber der zentralen Benutzerverwaltung des Portalverbund Online-Gateways. Weitere Informationen finden Sie in der Anbindungsanleitung.

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.