Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.