Versioning
0 min
When backward-incompatible changes are made to the API, a new, major version is released. The current version is v1. FourKites® uses Semantic Versioning to version its APIs.
The Accept header provides an ability to fetch different versions of the API. If no version is specified, the latest version of the API is used.
The following items are backward compatible and will not require the major version to be incremented:
- Adding properties to JSON objects.
- Changing the defaults or thresholds of the number of items returned in a single listing request.
- Changing rate limiting thresholds.
- The structure or length of identifiers (FourKites® given/generated identifiers) generated by the API.
- Changing error or status code messages.
The following items are considered backward in-compatible and will require the major version string to be incremented:
- Removing properties from JSON objects.
- Changing an APIs URL structure.