IF_011 – Bereitstelldienst administrieren

Maschinelle Web-Service Schnittstelle für den zentralen Administrationsdienst (Backoffice) über den die einzelnen Komponenten eines Online-Gateways administriert werden. Über diese Schnittstelle kann der zentrale Administrationsdienst Statusinformationen abrufen.

Endpunkte

Die Funktionen zur Administration des Bereitstelldienstes werden über eine REST API zur Verfügung gestellt. Die Tabelle enthält alle geplanten Endpunkte:

HTTP Methode	URL	Beschreibung
GET	/{version}/datenbestand-zustand	Gibt den aktuellen Zustand des Datenbestands (aufgeschlüsselt nach Redaktionssystem) zurück.

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 Bereitstelldienst 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.

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).

Anfrageparameter

Der Endpunkt /{version}/datenbestand-zustand besitzt keine Parameter.

Nachrichtenformat

Die Rückgabe der Antwort auf die GET-Anfrage an den REST-Endpunkt (/{version}/datenbestandzustand) erfolgt nach Wahl im XML oder JSON Format. Das folgende Beispiel zeigt den Aufbau der Antwort im JSON Format der aktuellen Schnittstellenversion (/v2/datenbestand-zustand):

{
    "redaktionssysteme": {
        "L100042": {
            "anzahlLb": 747,
            "anzahlSp": 6534,
            "anzahlOe": 8892,
            "anzahlOd": 356,
            "anzahlZsOd": 523,
            "anzahlZsOe": 1907559,
            "anzahlFo": 0,
            "anzahlZsFo": 0
        },
        "L100001": {
            "anzahlLb": 1128,
            "anzahlSp": 0,
            "anzahlOe": 6243,
            "anzahlOd": 123,
            "anzahlZsOd": 123,
            "anzahlZsOe": 113622,
            "anzahlFo": 0,
            "anzahlZsFo": 0
        }
    }
}

Es werden pro Redaktionssystem, welche durch die Scheme Agency ID identifiziert werden, die Anzahl an Leistungen (anzahlLb), Organisationseinheiten (anzahlOe), Leistungsspezialisierung (anzahlSp), Onlinedienste (anzahlOd), Zuständigkeiten von Onlinediensten (anzahlZsOd) und Zuständigkeiten von Organisationseinheiten (anzahlZsOe) ausgegeben. Die Schnittstelle in Version 2 und höher liefert zusätzlich die Anzahl an Formularen (anzahlFo)und Zuständigkeiten von Formularen (anzahlZsFo). In Version 1 der Schnittstelle sind Informationen zu Formularen nicht enthalten.

Rückgabecodes

Die REST Endpunkte zur Administration des Bereitstelldienstes antworten mit den folgenden HTTPStatuscodes auf eingehende Anfragen:

HTTP Statuscode	Endpunkt	Bedeutung
200	alle	Anfrage erfolgreich abgearbeitet.
401	alle	Autorisierung gegenüber Keycloak fehlt.
403	alle	Berechtigung für den Zugriff auf den Endpunkt fehlt.
500	alle	Interner Fehler bei der Verarbeitung der Anfrage.