IF_033 – Suchdienst administrieren
Der Suchdienst stellt eine REST-Schnittstelle für die Administration des Suchdiensts bereit. Die Schnittstelle wird von der Sub-Komponente Suchdienst-Anwendung bereitgestellt und von der Komponente Administrationsdienst (aka Backoffice) konsumiert.
Der Suchdienst stellt die Schnittstelle nur im PVOG-internen Netz zur Verfügung. Details zu den Schnittstellen sind in der Schnittstellen-Dokumentation auf dem PVOG Produktportal (öffnet in neuem Tab) abrufbar.
Die folgenden Abschnitte geben einen ersten Überblick über die grundsätzliche Funktionsweise der Schnittstelle.
Authentifizierung
Der Zugriff auf diese Schnittstelle ist nur für berechtigte Nutzer möglich. Aktuell ist nur der Administrationsdienst (aka Backoffice) berechtigt. Die Berechtigungsprüfung durch den Suchdienst erfolgt auf Basis eines OpenID Connect Access Tokens, das der Administrationsdienst beim Aufruf der Schnittstelle mitliefern muss. Detaillierte Informationen bzgl. des Anmeldeverfahrens können dem Dokument „PVOG-Berechtigungsmanagementkonzept“ (öffnet in neuem Tab, Download) entnommen werden.
Nutzungsfrequenz
Die Schnittstelle wird nur bei Bedarf und damit eher selten genutzt.
Verschlüsselung der Übertragungswege
Der Zugriff auf die Schnittstelle 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 (mindestens Version 1.2).
Nachrichtenformat Methode /v1/client-stats
Abfrage
Die maschinelle Schnittstelle des Suchdienstes verwendet REST-Services, die über HTTPS-GETRequests aufgerufen werden können. Die entsprechenden Methoden können wie folgt verwendet werden.
Übersicht möglicher Eingabeparameter
Pfad
/v1/client-stats
Beschreibung
Methode zum Abfragen der Anzahl eingelesener Leistungen pro PVTeilnehmer (Bund, Länder).
Beispiel
https://mein.server.de/suchdienst/api/v1/client-stats (öffnet in neuem Tab)
Ergebnis
Die Methode liefert die Anzahl der Verwaltungsleistungen, die für die einzelnen Bundesländer, bzw. dem Bund im Gesamtdatenbestand des Suchdiensts vorliegen.
Beispielhaftes Ergebnis der Anfrage (Request)
{
"timestamp":"2019-10- 29T18:41:02.442718Z",
"stateServices":{
"11":679,
"09":411,
"02":718,
"-":32,
"06":1236
}
}
Erläuterung zu „Schlüssel“: AnzahlDerLeistungen
| 00 | Bund |
| 01 | Schleswig-Holstein |
| 02 | Hamburg |
| 03 | Niedersachsen |
| 04 | Freie Hansestadt Bremen |
| 05 | Nordrhein-Westfalen |
| 06 | Hessen |
| 07 | Rheinland-Pfalz |
| 08 | Baden-Württemberg |
| 09 | Bayern |
| 10 | Saarland |
| 11 | Berlin |
| 12 | Brandenburg |
| 13 | Mecklenburg-Vorpommern |
| 14 | Sachsen |
| 15 | Sachsen-Anhalt |
| 16 | Thüringen |