Hinweise zur Weiterentwicklung der OPENWOWI

Über den Umgang mit Endpunkten in den laufenden Versionen

Die OPENWOWI lebt und entwickelt sich gemeinsam mit den Wünschen unserer Kunden und unserer Partner.

Dieser Grundsatz bedeutet, dass wir in den laufenden Versionen manchmal Änderungen vornehmen, um diesen Anforderungen gerecht zu werden. Die Wünsche nach Schnelligkeit, Verlässlichkeit und Flexibilität sind nur schwer miteinander in Einklang zu bringen.

Wir hoffen, dass Transparenz in unserer Vorgehensweise es uns erlaubt, alle Anforderungen zu erfüllen.

Bei der Weiterentwicklung unserer API möchten wir Sie deshalb bitten, Folgendes zu beachten:

  • Bei Veröffentlichung einer neuen Version wird die letzte Version zur "stabilen" Version und erfährt keinerlei Änderungen mehr.

  • Die neue Version wird zu einem "Work in Progress" und kann jederzeit Änderungen erfahren.

  • Wurde ein Endpunkt in dieser Dokumentation noch nicht veröffentlicht, können sich sowohl die Route, der Parameter als auch der Inhalt und die Struktur ändern.

  • Sobald ein Endpunkt in dieser Dokumentation veröffentlicht wurde, gehen wir davon aus, dass dieser in einem produktiven System eingesetzt wird, und wir werden keine Änderungen an der Route oder an der Gesamtstruktur vornehmen. Auch verpflichtende Parameter werden nicht mehr hinzugefügt.

  • Erweiterungen im Dateninhalt (einzelne Schlüssel) oder der optionalen Parameter eines API-Endpunktes der aktuellen Version können jederzeit erfolgen.

  • Die Bezeichnung der Schlüssel innerhalb der JSON-Daten ist dabei nicht einzigartig und sollte deshalb mit der konkreten Bezeichnung der Knotenpunkte verarbeitet werden.

  • Abkündigungen von API-Versionen werden unseren Kunden und Partnern mit einer Vorlaufzeit von drei Monaten angekündigt.

Zum derzeitigen Stand (Juni 2023) sind die Endpunkte der Version 1.0 und 1.1 als stabil anzusehen.

Aus der Version 1.2 wurden alle Endpunkte, mit Ausnahme der Endpunkte der Anlagenbuchhaltung, veröffentlicht.

Die Endpunkte der Umlagenabrechnung können sich im Zuge von Anpassungen im WOWIPORT Modul ändern. Für die Stabilität dieser Endpunkte kann keine Garantie übernommen werden.

Bitte beachten Sie, dass die Entwicklung OPENWOWI API im Einklang mit der Entwicklung und der strategischen Ausrichtung von WOWIPORT erfolgt. Aus diesem Grund werden nur spezifische Prozesse abgebildet. Wir behalten uns vor, bestimmte Entwicklungswünsche abzulehnen.

Last updated