API Breaking Changes

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:

1. removing an endpoint
2. removing or renaming a parameter
3. removing or renaming a response field
4. adding a new required parameter
5. making a previously optional parameter required
6. changing the data type of a parameter or response field
7. removing enum values
8. adding a new validation rule to an existing parameter
9. changing authentication or authorization requirements

Additive Changes

Additive changes are changes that should not break an integration. An additive change could include:

1. adding an endpoint
2. adding an optional parameter
3. adding an optional request header
4. adding a response field
5. adding a response header
6. 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.