Beschreibung der Schnittstelle

Der Bereitstelldienst ist als Teil des Portalverbunds dafür zuständig, den durch den Sammlerdienst von den verschiedenen Redaktionssystemen der Verwaltungsportale eingesammelten Gesamtdatenbestand im XZuFi-Format (öffnet in neuem Tab) für verschiedene Abnehmer bereitzustellen. Im Folgenden soll hier die REST-Schnittstelle /{version}/verwaltungsobjekte näher beschrieben werden, die die Inhalte für externe Konsumenten bereitstellt.

Versionierung

Die Bereitstelldienst-Schnittstelle ist versioniert. Neue Versionen werden mit mindestens 3 Monaten Übergangszeit eingeführt, veraltete Versionen werden zum Quartalsende deaktiviert.

Funktionalität

Der Bereitstelldienst speichert stets nur den neuesten Stand jedes Verwaltungsobjekts und liefert auf Anfrage alle Änderungen seit einem angegebenen Zeitpunkt aus.

Authentifizierung und Autorisierung

Zugriff auf den Bereitstelldienst erfordert eine Registrierung als Client bei Keycloak. Nach Erhalt von Client-ID und Secret wird per OAuth2 Client Credentials Flow ein Bearer Token abgerufen, das bei jedem API-Aufruf mitzusenden ist.