šŸ”¢ API versions

Every reply from the SnapRefund API carries a header named X-Snapr-Api-Version. Its value is the version of the API that answered, for example:

X-Snapr-Api-Version: 2.0.0

The current version is 2.0.0.

What the number means

The number has three parts, written MAJOR.MINOR.PATCH. SnapRefund sets it by hand, and raises it only when the API changes for the people who call it. A new release that leaves the API as it was does not change the number.

  • First part (MAJOR) goes up when something you may rely on is removed or changes meaning. Programs written for the old version could break.
  • Second part (MINOR) goes up when something new is added that your existing calls do not notice, such as a new endpoint or an optional field.
  • Third part (PATCH) goes up for a fix that does not change what the API looks like.

Do I need to do anything?

No. Your existing calls keep working. The header is extra information. You can ignore it, or write it to your logs so you know which version answered each call.

Version history

VersionWhat changed
2.0.0First version number shown on replies. It matches the 2.0 the API definition has shown since 2023. The API itself did not change.

Did this page help you?