Neue JZuFi Endpunkte pro XZuFi Version im Suchdienst
Mit der Umstellung auf XZuFi 2.3.1 wurde in den JZuFi Endpunkten implementiert, dass die XZuFi-Version beim Abruf im http-Header angefordert werden musste.
Zwischenzeitlich erreichte uns eine Kundenanforderung, zu JZuFi Endpunkten, die mit dem Codegenerator die gewünschte XZuFi-Version nicht korrekt abrufen konnte.
Da eine entsprechende Konfiguration des Codegenerators nicht möglich war, erfolgte im Release 9.16 eine Erweiterung der Endpunkte durch die Einführung von zwei Methoden pro Endpunkt, um die Kompatibilität mit dem Codegenerator zu gewährleisten.
Im Detail wurden ab Version 9.16 verschiedene Endpunkte als deprecated markiert, während parallel neue Versionen mit differenzierten Pfaden eingeführt wurden, die explizit die jeweilige XZuFi-Version in der URL abbilden.
| Ab PVOG Release 9.16. (Deployment Produktion am 5.5.2026) | |
|---|---|
/v1/organisationunits/jzufi | deprecated |
/v2/servicedescriptions/jzufi | deprecated |
/v2/relations/{ars}/jzufi | deprecated |
/v3/organisationunits/jzufi - deprecated | /v1/organisationunits/:id/jzufi-2-2 |
/v1/organisationunits/:id/jzufi-2-3 | |
/v3/relations/:ars/jzufi - deprecated | /v1/relations/jzufi-2-2 |
/v1/relations/jzufi-2-3 | |
/v2/servicedescriptions/jzufi - deprecated | /v1/servicedescriptions/:id/jzufi-2-2 |
/v1/servicedescriptions/:id/jzufi-2-3 |
Das zugrundeliegende Schema der Endpunkte blieb unverändert, sodass lediglich die URL angepasst werden muss, um die gewünschte Version anzusprechen.
Details zu den Endpunkten sind auf dem Produktportal oder in der OpenAPI Dokumentation einzusehen.
Insgesamt stellt diese Anpassung sicher, dass trotz der Einschränkungen des Codegenerators eine korrekte und flexible Nutzung der JZuFi-Endpunkte mit unterschiedlichen XZuFi-Versionen möglich ist. Mit Release 9.16. werden die Endpunkte ohne XZuFi-Version ebenfalls auf „deprecated“ gesetzt. Die Termine können dem Produktportal/Ressourcen/Deprecations entnommen werden.
Für Nutzer der PVOG Suchdienst REST APIs wird die Verwendung von API Keys empfohlen, um die Weiterentwicklung der Schnittstellen zu unterstützen. Informationen zur Beantragung und Nutzung der API Keys sind auf dem PVOG Produktportal verfügbar.
