Versions
Cardlytics APIs are versioned through the URL. At the time of writing, there is currently only one version of the API, v1. The API version does not correspond to the underlying version of Ad Server and, instead, is used to identify API contract compatibility. An example of the version specifier within the URL is as follows:
1 | |
Generally speaking, the API major version specified in the URL will increment only when a major breaking change is introduced to the API contract. A major breaking change is defined as a change which would render existing API access code incompatible, such as:
- Changing the HTTP verb of an endpoint
- Removing or renaming a property from a request or response JSON
- Changing the JSON data type of a response property
The version specified in the URL is only the major version. There could be minor, non-breaking changes made to the API contracts that will result in minor version increments that do not affect existing client communications and thus do not require an increment of the API major version.