Our API will be versioned with "v1", "v2" etc. in the URL path. We won't increase version number very often and even when we do, we will still continue to support the old version for at least another year.

Within a version, our API will always be backwards compatible. There are however some changes that we will make within a version because we consider them backwards compatible:

  • Adding new API resources
  • Adding a new optional parameters or changing the order of parameters of existing resources, both for requests and responses
  • Adding new values for existing parameters, e.g. "status" fields or "reason" fields in error codes
  • Changing the length of the Yordex generated fields of existing resources, e.g. "id" fields

We will not warn you in advance when we make any of these changes, so please make sure that your code does not break when we do.