Technische Erkennung abgekündigter Schnittstellen

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:

• Zum einen über die UserGroup Protokolle und das Produktportal im Bereich Ressourcen/Deprecations,
• zum anderen durch eine technische Lösung mittels eines speziellen Response-Headers.

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)