Versioning
We take versioning very seriously, as we recognize that breaking changes can be very disruptive. If we need you to switch from a legacy endpoint, we will notify you with adequate time to make the change. Also, when we create new versions of our API, we maintain previous versions while we can to avoid any breaking changes to your code. However, we recommend implementing the most recent version of all endpoints.
Allawee API changes are tracked with dated versions. The current version is 2023-02-01. We provide an upgrade guide and changelog to help you keep track of changes you need to make and what is different between versions. Your version is set when you create a new API key on your dashboard. The default version is the most current version when your API key created, although you can change this from the dashboard. You can also override the default API version by including a Allawee-Version: {API version} in your request header.
Breaking changes
We do not consider the following changes to be breaking changes and so you do not have to worry about them breaking your code:
- New endpoints.
- New optional fields for POST requests.
- New read-only fields in responses.
Note: New kinds of responses should not break your code. Make sure your code can handle new fields in the responses and unknown enum types.
Last updated Aug. 01, 2023