Versionierung

Newtrition Data UG (haftungsbeschränkt) ist bestrebt, Abwärtskompatibilität für alle API-Endpunkte zu erhalten. Wir behalten uns jedoch vor, zukünftig Änderungen an der REST-API vorzunehmen, die Abwärtskompatibilität brechen können. Über Breaking Changes informieren wir rechtzeitig und geben Hinweise, wie Sie Ihren Code anpassen sollten. Dazu gehören unter anderem:

• Neue Ressourcen (URLs) zur API hinzufügen
• Neue optionale API-Parameter hinzufügen
• Reihenfolge von Properties in einem JSON-Response-Objekt ändern
• Länge oder Format opaker Strings ändern (z. B. Resource-IDs und UUIDs)

Grundsätzlich gilt:

• Versionierung: Die API-Version ist im URL-Pfad enthalten, z. B. /v1/ oder /v2/.
• Implizite Versionierung: Wenn keine Version angegeben ist, wird die neueste stabile Version der API verwendet. Es wird empfohlen, explizit eine Version anzugeben, um unerwartete Änderungen zu vermeiden.
• Lebenszyklus älterer Versionen: Aus Gründen der Wartbarkeit sowie zur Sicherstellung der Kompatibilität mit unserer Datenbank behalten wir uns vor, ältere API-Versionen nach einer angemessenen Übergangsfrist außer Betrieb zu nehmen. Änderungen dieser Art werden nach Möglichkeit vorab angekündigt.

Für Migrationen zwischen Hauptversionen siehe unsere Migrationsleitfäden, z. B. hier. Informationen bezüglich unserer Lebensmittel-Datenbank Updates, finden Sie hier.