Versioning will be specified by the release date of each version, at first and due to the simplicity of the API all calls will be made through the same version. Version changes will be notified by the usual means and will be done automatically as long as they are backward compatible.

Backward compatibility

A version is considered to be backwards compatible with the previous version whenever:

  • Adding endpoints

  • Adding options to call parameters

  • Adding attributes to response resources

  • Do not modifying/removing call parameters or their interpretation

  • Do not modifying endpoint responses

  • Do not deleting endpoints

For this reason it is recommended that if your integration uses schema-based validation of the API be flexible in accepting new attributes in the resources.

Last updated