Version: 8.5.1

• OpenAPI Spec

Portalverbund - Validator Backend REST-API

Das Portalverbund-Onlinegateway (PVOG) stellt zentral die Verwaltungsleistungen von Bund und Ländern bereit. Die Aufgabe des Validators ist es, eine technische und fachliche Prüfung der XZuFi Dokumente durchzuführen, die über den Sammlerdienst in den Datenbestand des PVOG übernommen werden sollen. Die vom Validator bereitgestellte REST-API bietet die unabhängige Möglichkeit der fachlichen und technischen Prüfung von XZuFi Dokumenten, um die Erfüllung der Anforderungen an Importe in das PVOG zu prüfen. Die REST API des Validator Backend ermöglicht es, XZuFi 2.2 und 2.3 Dokumente von einem Bereitstellort zu validieren.

Weitere Informationen zur Versionierung der Schnittstellen finden Sie in unserem Produktportal.

Authentifizierung / Autorisierung:

Die Zugangsdaten für Ihr Redaktionssystem erfragen Sie bitte beim Support.

Die Endpunkte sind des Validators sind mit OAuth2 abgesichert. Folgende Grant Types werden unterstützt:

• Authorization Code
• Client Credentials

Die Endpunkte des Validators kann man in diesem Swagger-UI folgendermaßen testen:

1. Den gewünschten REST-Endpunkt auswählen
2. Auf das offene Schloss im rechten Bereich klicken. Es öffnet sich ein Dialog
3. Im Dialog im Feld client_id den Wert "validator-frontend" eingeben. Das Feld client_secret bleibt leer.
4. Auf den Button "authorize" klicken. Dies führt dazu, dass sich ein neuer Tab / ein neues Fenster öffnet.
5. In der Login-Maske meldet man sich mit denselben Zugangsdaten an, die man auch für das Validator-Frontend nutzt.
6. Auf den Button "Sign in" klicken. Dies führt dazu, dass sich der neue Tabl / das neue Fenster schließt. Das Swagger-UI zeigt in dem Dialog an, dass man angemeldet ist und aus dem ursprünglichen "authorize"-Button wurde der "logout"-Button.
7. Auf den Button "Close" klicken. Ab jetzt kann man die REST-Endpunkte wie gewohnt im Swagger-UI nutzen.

Authentication

OAuth 2.0: pvog_auth

Security Scheme Type:	oauth2
OAuth Flow (authorizationCode):	Token URL: https://stage.pvog.fitko.net/auth/realms/pvog/protocol/openid-connect/token Authorization URL: https://stage.pvog.fitko.net/auth/realms/pvog/protocol/openid-connect/auth Scopes:

Contact

FITKO:

URL: https://www.fitko.de/

License

Creative Commons Attribution Share Alike 4.0 (CC BY-SA 4.0)