API:v1r1:versioning

From MixxHelp

Jump to: navigation, search

API Main

API Versioning

The Mixx API is a versioned API. What this means is that part of the endpoint you'll send API calls to includes a string that identifies the version of the API you wish to use. It was done this way so that if, in the future, we have a need to change the API in a way that would break the interface contract (i.e., we change the requirements surrounding input, or change the output of existing calls), we can do that without requiring everyone else to rewrite their applications. With a versioned api, we can release a new version with new endpoints, and the older version will continue to work.

Note that adding functionality which does not break backwards-compatibility does not violate the interface contract, so the current version of the API has plenty of room to grow before we need to branch to a new version number.

Personal tools