This article outlines Wiserfunding's API versioning policy.
Wiserfunding introduces new changes to the API in two ways depending on the changes being implemented;
- Current version enhancement,
- New version release.
When Wiserfunding releases a new API version, customers can choose to upgrade to gain access to new features. When changes are implemented into a current API version, these improvements will become available to integrations using this version, without needing an API upgrade.
The most recent product improvements as seen in the online platform will only be included in the latest version of the API. We strongly recommend always upgrading as soon as possible to the latest version in order to take advantage of new features and functionality.
Current version enhancement
Wiserfunding will implement changes into current API versions, without a new version release, only when the changes being introduced will not interfere with your integration. These changes represent independent features which do not require you to alter your code.
For example:
- Adding new API endpoints,
- Adding optional request parameters to existing API endpoints,
- Reordering properties returned from existing API endpoints,
- Adding new properties to the responses from existing API endpoints,
- Adding new values to existing properties in responses,
- Adding new error response codes.
New version release
Wiserfunding will release a new API version if any of the changes being introduced are not backwards compatible. In this case upgrading to a new version means you will need to update your code.
Wiserfunding considers the following changes to not be backwards compatible;
- Removing an endpoint in the API,
- Removing or renaming a resource, field, method or an enum value,
- Changing the type of a field (eg. integer becomes string or float),
- Changing the URL format,
- Changing the meaning of a field even if the type is unchanged,
- Changing existing error response codes.
Support and Deprecation
All our API versions are released with an indefinite support until a deprecation is issued. These come in two ways depending on the changes being implemented;
- A version being deprecated,
- An endpoint being deprecated when a better alternative is available.
Deprecation notices will be available:
- In the API documentation on the platform,
- As a header on API responses.