API Versioning

API Versioning

The Mashery API as documented here is fully supported and we are committed to backward compatibility.  This page describes which changes might occur that would cause the version to be incremented and which kinds of changes might occur that would not cause a new version.

Custom Fields and Validations

The Mashery portal allows custom fields to be created on Member, Application, and Role objects.  Certain fields from those objects may also be created.  Customized validation rules may also be added. These customizations may result in changes to the fields that appear in the api and some of the properties returned by object.describe.  These customizations will not result in the versioning of the api.

Additions

Applications using the Mashery API should expect that fields could be added to objects returned by the API without creating a new version of the API.  These fields would, of course, appear in the result of object.describe.  Methods may also be added and optional parameters may be added to existing methods.  New object types may also be added.  New relationship properties may also be added for existing objects.

Notification

We will provide ample notification before deprecating the current version of the API or making changes known to be backward incompatible.