In order to enhance the Validic API without impacting existing customer implementations, Validic may maintain multiple versions of the API. This system allows the customer to manage which version they are using and change at their own pace.
Any changes made to the API that are deemed backward-incompatible will be made in a new version.
The following list of changes is considered compatible with existing integrations and do not require an updated version of our API as they should not disrupt your current integration. Your system should be configured to accept, or ignore, these types of changes as they arise:
- Adding a new resource (e.g., a new data object)
- Adding a new optional request parameter to an existing method
- Adding a new property to a response
- Changing the order of properties in an existing response
- Adding new metric types in an array
The following list of changes are considered breaking changes and will only be released in a new version of our API. You will not be required to change to the latest version immediately; however, you should anticipate that we will eventually deprecate or eliminate support for older versions.
- Renaming a property in a response
- Adding new required request parameters to an existing method
- Changes to HTTP status code responses
- A new error condition in response to a request parameter value
- Any change which disrupts the reasonable and expected use of REST API's
Updated 2 years ago