Skip to content
Newtrition Data

Versioning

Newtrition Data UG (haftungsbeschränkt) strives to maintain backward compatibility for all API endpoints. However, we reserve the right to make changes to the REST API that may break backward compatibility in the future. We will communicate any breaking changes well in advance and provide guidance on how to adapt your code. This includes, but is not limited to:

  • Adding new resources (URLS) to the API
  • Adding new optional API parameters
  • Changing the order of properties in a JSON response object
  • Changing the length or format of opaque strings, like resource identifiers and UUIDs

The following generally applies:

  • Versioning: The API version is included in the URL path, e.g., /v1/ or /v2/.
  • Implizite Versioning: If no version is specified, the latest stable version of the API will be used. It is recommended to explicitly specify a version to avoid unexpected changes.
  • Lifecycle of older versions: For reasons of maintainability and to ensure compatibility with our database, we reserve the right to deprecate and eventually remove older API versions after an appropriate transition period. Such changes will be announced in advance whenever possible.

For migrating between major versions, see our Migration guides, for example here. Information regarding our database updates, see here.