Um den vielfältigen Anforderungen gerecht zu werden, ist der Suchdienst mit zahlreichen Schnittstellen ausgestattet. Über die internen Schnittstellen ist der Dienst an weitere Komponenten von suchen&finden angeschlossen, insbesondere den Sammlerdienst, der die Nutzdaten im aufbereiteten XZuFi-Format anliefert. Weiterhin ist der Suchdienst per interner Schnittstelle an Elasticsearch angeschlossen. Die auf diese Weise bereitgestellte verteilte Such- und Analysefunktionalität ist ein wesentlicher Faktor, um Suchanfragen schnell und mit einer hohen Treffergenauigkeit zu beantworten. Elasticsearch bietet eine Schnittstelle auf Basis von REST und JSON für Suchanfragen an, welche durch den Suchdienst mit einer REST-Fassade nach außen gekapselt wird.

Diese eingehenden Suchanfragen umfassen Verwaltungsleistungen, Organisationseinheiten und Ortsangaben und werden über die externen Schnittstellen gestellt. Bei diesen handelt es sich um REST-Schnittstellen, die je nach Konsumentenanforderung die gewünschten Daten in unterschiedlichem Format liefern. Aktuell können alle Daten als JZuFi (XZuFi als JSON) oder in einer reduzierten, dafür aber schlanken und auf die Bedürfnisse von mobilen Endgeräten zugeschnittenen Form als JSON bezogen werden. Bei allen Anfragen kommt dabei das HTTPS-Protokoll zum Einsatz, um den zahlreichen Sicherheitsanforderungen zu genügen. Der Bürger kann auf einem angeschlossenen Verwaltungsportal nach einer beliebigen Verwaltungsleistung suchen und erhält als Ergebnis eine Trefferliste mit Ergebnissen aus dem gesamten Verbund.

Die externe Schnittstelle ist ohne Authentifizierung öffentlich aus dem Internet erreichbar.

Die folgende Tabelle listet die aktuellen Routen des Suchdienstes und zugehöriger Komponenten auf und erläutert ihre grundlegende Bestimmung:

Die externen Schnittstellen ermöglichen das Suchen und Finden von Verwaltungsleistungen, Organisationseinheiten und Onlinediensten an den von den Bürgern gewünschten Orten.

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.