API Versioning

Owned by Ulrik Bærholm (IT-wrk) (Unlicensed)
Last updated: Feb 25, 2022 by Morten Østerlund Jørgensen

HIMSA strives to provide developers with stable APIs to integrate against while still being able to provide new and expanded functionality.

To balance these two goals we provide different API versions and only add new features to the latest version of the API. This allows you to choose the best time to update your integration and take advantage of new features.

Requesting a version

Specify version in the X-Api-Version header.

API Deprecation

To signal that an API version is deprecated and will be removed in the future, the API responds with the following headers:

Noah-Deprecated: Boolean
Noah-Sunset-Date: ISO 8601 date time (UTC) when the version will no longer be accessible.

Your integration should check for those headers so you can make updates in a timely fashion.