Smartling’s API is versioned. The API version is included in the URL of the API endpoint. Any breaking changes will be released in a new API version.
Some examples of breaking changes include:
removing an endpoint
removing or renaming a parameter
removing or renaming a response field
adding a new required parameter
making a previously optional parameter required
changing the data type of a parameter or response field
removing enum values
adding a new validation rule to an existing parameter
changing authentication or authorization requirements
Additive Changes
Additive changes are changes that should not break an integration. An additive change could include:
adding an endpoint
adding an optional parameter
adding an optional request header
adding a response field
adding a response header
adding enum values
When using Smartling’s APIs, your integration should be able to handle additive changes to the APIs, such as unknown fields and enumeration values, without causing any issues for your integration.