Die Verwendung von API Keys ermöglicht schnellere und zielgerichtetere Unterstützung durch den PVOG Support bei Problemen oder API‑Änderungen.
API Keys können über das Formular auf dem Produktportal angefordert werden.
Zusätzlich ermöglicht die Nutzung von API Keys eine bessere Möglichkeit zur Benachrichtigung und Betreuung der API‑Konsumenten bei wichtigen Änderungen. Weitere Informationen sind hier auf dem Produktportal nachlesbar.
Die Hauptaufgabe des Validators besteht in der technischen und fachlichen Prüfung der XZuFi-Dokumente, die über den Sammlerdienst in den Datenbestand des PVOG übernommen werden sollen. Dabei werden sowohl die Validierungsregeln als auch die technische Funktionalität der PVOG-Komponente Validator kontinuierlich weiterentwickelt, um eine zuverlässige und präzise Datenkontrolle zu gewährleisten.
Die Redaktionssysteme können zu übermittelnde Daten mithilfe spezieller Schnittstellen direkt gegen den Validator prüfen, bevor sie an den Sammlerdienst gesandt werden. Diese Validierung kann entweder manuell über den Validator Service oder maschinell per Validator APIs jeweils pro PVOG Umgebung erfolgen. Die Prüfergebnisse liegen direkt vor.
Im November 2025 wurden im Zuge dieser Weiterentwicklung zwei neue Validator Endpunkte eingeführt, die nicht abwärtskompatibel sind und speziell auf die Anforderungen technischer Dienstleister mehrerer Redaktionssysteme zugeschnitten sind.
validator-backend/api/v6/validiere, nutzt zur eindeutigen Identifikation des Redaktionssystems nun die SchemeAgencyID (redaktionssystemId) als verpflichtendes Feld.validator-backend/api/v2/:redaktionssystemId/redsyskonfig, ebenfalls die SchemeAgencyID zur eindeutigen Erkennung des Redaktionssystems.Diese Umstellung auf die SchemeAgencyID dient der verbesserten Datenkontrolle und Systemzuordnung. Gleichzeitig wurde angekündigt, dass die bisherigen Schnittstellen validator-backend/api/v5/validiere und validator-backend/api/v6/validiere bis Mai 2026 abgekündigt werden, was eine Umstellung auf die neuen Endpunkte erforderlich macht.
Die Nutzung der Validator-Schnittstellen ist nicht öffentlich zugänglich, sondern setzt einen Benutzer mit entsprechendem Authentifizierungstoken voraus, um die Sicherheit und Integrität der Datenverarbeitung zu gewährleisten.
Redaktionssysteme, die Interesse an einem Zugang zum Validator Service oder einem automatisierten Abruf der Validatorergebnisse haben, werden gebeten, sich an den PVOG Support zu wenden, um entsprechende Zugänge und Unterstützung zu erhalten.
Für Nutzer des manuellen Validator-Services ergeben sich durch die Einführung der neuen Endpunkte keine Änderungen, sodass der bisherige Workflow unverändert fortgeführt werden kann.
Das PVOG wird kontinuierlich in seinen Komponenten weiterentwickelt; auch hinsichtlich der Schnittstellen, über die Daten aus den Redaktionssystemen abgerufen und bereitgestellt werden.
Die Weiterentwicklung der Schnittstellen manifestiert sich in der Einführung neuer API-Versionen bei größeren Verbesserungen. Dies führt dazu, dass ältere API-Versionen nach einem definierten Zeitraum abgeschaltet werden, um die Schnittstellen effizient mit neuen Funktionalitäten erweitern zu können.
Die Abschaltung veralteter API-Versionen ist somit ein notwendiger Schritt zur Sicherstellung der Weiterentwicklung und Modernisierung der Schnittstellen.
Nutzer werden über die Abkündigung (Deprecation) von Schnittstellen auf mehreren Wegen informiert:
Technisch signalisiert eine als deprecated gekennzeichnete API in der Antwort den Header „x-pvog-deprecated: true“, während aktuelle Schnittstellen diesen Header nicht enthalten. Dies ermöglicht eine automatisierte Erkennung veralteter Schnittstellen durch die Nutzer.
(Text überarbeitet von LLMoin)
Mit Release 9.8 wurde die neue Suchdienst Schnittstelle suchdienst/api/v6beta3/servicedescriptions/:lbid/detail vorgestellt.
Diese neue API wurde im Vergleich zu suchdienst/api/v5/servicedescriptions/:ars/detail
im Modell verschlankt und ist nicht abwärtskompatibel. Nun fragen wir unsere
PVOG Nutzer nach Feedback bis zum 31.12.2025:
Der Vergleich der Schnittstellen wird in folgender Übersicht dargestellt:
| Neu - Bitte um Feedback! | Bestehend |
|---|---|
| suchdienst/api/v6beta3/servicedescriptions/ | suchdienst/api/v5/servicedescriptions/ |
Felder mit * sind Pflichtfelder.
Ergänzend zur Verschlankung werden in v6beta3/servicedescriptions/:lbid/detail Informationen aus den Leistungsmodulen mit den Zugangskanälen in den Details abgebildet.
Das Feld „name“ aus dem leikaTextModul wird nach aktuell geltenden Regeln befüllt:
Das Feld „details“ enthält detaillierte Information aus den Leistungsmodulen inklusive Zugangskanal im Feld „accessChannel“.
Für Feedback bitten wir um Kontaktaufnahme über unser Postfach dataportpvogsupport@dataport.de .