Keep track of changes to the Yousign API
API version controls the API and webhooks behavior you see (what resources you can request, what properties you see in responses, what parameters you’re allowed to send in requests, and so on).
Yousign API use semantic versioning, API major version is part of the URL path https://api.yousign.app/{version}
Example for the current version (v3) : https://api.yousign.app/v3
Each time a non backward compatible change (breaking change) is introduced to the Yousign API, a new major version is released.
Backwards Compatible Changes
A backward compatible change is a change in the Yousign API contract.
Yousign considers the following changes to be backwards compatible and do not involve a major version release:
- Adding new API resources / endpoints.
- Adding new optional request parameters to existing API endpoints.
- Adding new properties to existing API responses.
- Changing the order of properties in existing API responses.
- Changing the length or format of strings, such as object IDs, error messages, and other human-readable strings.
- IDs will never have length greater than 255 characters.
- Error detail may change but not the type of the error.
- Adding new event types on our Webhooks.
When an endpoint or a property is deprecated, you don't need to change anything in your code, it will still work and it is not planned to be suppressed.
We give you the new property name and it should be used for new implementations. Indeed, we advice to use the new property to remain compatible with future versions of the API