IF_009 – Suche nach Verwaltungsleistungen (Web)
Die grafische Benutzerschnittstelle für die Suche nach Verwaltungsleistungen, die im Suchdienst implementiert ist, ist als Single Page Application (SPA) implementiert. Beim ersten Aufruf der Web- Anwendung wird der gesamte Client in Form von HTML, CSS und JavaScript heruntergeladen. Im Wesentlichen besteht der Client aus der grafischen Benutzerschnittstellen und JavaScript-Methoden für die Kommunikation mit dem Suchdienst-Backend und dem Nachladen von Daten. Die folgenden Abschnitte geben einen ersten Überblick über die grundsätzliche Funktionsweise der Schnittstelle.
Endpunkte
Nachfolgend sind alle Endpunkte von PV-Teilnehmern aufgeführt, über die der Suchclient des Online-Gateways heruntergeladen werden kann.
Das Erscheinungsbild des Suchclients ist abhängig von der URL, über die der Suchclient geladen worden ist.
Weitere Endpunkte können bei Bedarf der einzelnen Portalverbundteilnehmer eingerichtet werden. Anfragen zum Einrichten weiterer Endpunkte im Rahmen der Anbindung einzelner Portalverbundteilnehmer können über das Funktionspostfach dataportpvogsupport@dataport.de gestellt werden.
Authentifizierung
Die Verwendung der Schnittstelle erfordert keine Authentifizierung, sondern kann anonym genutzt werden.
Nutzungsfrequenz
Die Nutzungsfrequenz ist abhängig von der Anzahl der Verbundteilnehmer, die den Suchclient in ihre Verwaltungsportale integriert haben und dem Bedürfnis der Verwaltungskunden eine deutschlandweite Suche in Anspruch zu nehmen. Im Rahmen des Projekts wurden Prognosen bzgl. der Nutzungsfrequenz dieser Schnittstelle auf Basis unterschiedlicher Nutzungsszenarien erstellt. Im Dokument „Konzept Anforderungen an Last und Performance an das Online-Gateway Portalverbund (öffnet in neuem Tab, Download)“ werden die Szenarien und die daraus abzuleitenden Anforderungen bzgl. der Nutzungsfrequenz für diese Schnittstelle näher beschrieben.
Verschlüsselung der Übertragungswege
Die Übertragung der bereitgestellten Leistungsdaten muss über eine verschlüsselte Verbindung erfolgen, um ausschließen zu können, dass die Daten während der Übertragung manipuliert werden können. Die Verschlüsselung der Übertragungswege erfolgt auf Basis von TLS (HTTPSVerbindung). Dies gilt für alle Endpunkte der API.
Nachrichtenformat Abfrage
Der Aufruf der Schnittstelle erfolgt über einen HTTPS-GET-Request.
Suche nach Verwaltungsleistungen (Web)
Die folgende Übersicht enthält einen Überblick der möglichen Eingabeparameter.
Pfad
/!/result/{ars}
Beschreibung
Methode, um den Suchclient vollständig in den Browser zu laden.
Parameter
| Name | Bedeutung | Beispiel |
|---|---|---|
| ars | Amtlicher Regionalschlüssel des Orts, der bei der Anzeige des Suchclients im Browser für die Vorbefüllung des Eingabefelds für die Ortsangabe verwendet werden soll. | 120645410340 |
Beispiel
https://pvog.hamburg.de/!/result/020000000000/ (öffnet in neuem Tab)
Nachrichtenformat Abfrage
Ein Aufruf der Endpunkte dieser Schnittstelle führt zum Download der Suchclient Anwendung. Diese ist als Single Page Application umgesetzt und besteht damit aus einer Menge von HTML-, CSS-, JavaScript- und Bilddateien. Die Abbildung zeigt einen Screenshot des Standard Suchclients.
Standard Suchclient des Online-Gateways
Das Erscheinungsbild der grafischen Benutzerschnittstelle ist abhängig von der URL, über die der Suchclient aufgerufen wird. Das Erscheinungsbild des Clients wird in unterschiedlichen CSSDateien definiert. Jeder URL ist ein Paket von CSS-Dateien zugeordnet. Beim Suchclient wird das dazugehörige Paket von CSS-Dateien über den entsprechenden Endpunkt nachgeladen und für den Aufbau des Erscheinungsbilds verwendet. Die URL, über die der Client aufgerufen wurde (z. B. /assets/client?url=https://suche.meunchen.de), wird dabei übergeben. Beim Aufruf der Benutzerschnittstelle wird dann die entsprechend benötigte CSS-Datei verwendet, um das gewünschte Aussehen der grafischen Benutzerschnittstelle zu erhalten.