API reference
The AOA API versioning and deprecation policy: what changes without a new version, the Deprecation and Sunset headers, 90 days before shutdown.
Versioning: the version is part of the path (/api/v1). Breaking changes ship only in a new version. Every API response carries a Link header with rel="deprecation" and rel="sunset" pointing to this policy page. A deprecated endpoint is also marked with the Deprecation and Sunset headers (RFC 9745, RFC 8594) at least 90 days before it is switched off, and the shutdown date is repeated in the documentation.
The current version is v1, and no endpoints are deprecated.
These changes don’t break integrations, so they ship in v1 without notice. Plan for them in your code:
| Change | How it ships |
|---|---|
| Removing or renaming a field | Only in a new version |
| Changing a field type or value format | Only in a new version |
| A new required parameter | Only in a new version |
| Removing an endpoint | Deprecation, at least 90 days |
Every API response, errors included, carries a Link header to this page with rel="deprecation" and rel="sunset". Without a Deprecation header it means “this endpoint isn’t deprecated, here is our policy” (RFC 9745, section 3.1), so an integration can find the policy without reading the docs:
HTTP/1.1 200 OK
Link: </docs/api-reference/versioning>; rel="deprecation"; type="text/html", </docs/api-reference/versioning>; rel="sunset"; type="text/html"A deprecated endpoint keeps working, but every response from it carries the Deprecation (RFC 9745, when it was announced) and Sunset (RFC 8594, the shutdown date) headers, and Link with rel="deprecation" points to this page. There are at least 90 days between the announcement and the shutdown; the shutdown date also appears in the endpoint’s documentation.
HTTP/1.1 200 OK
Deprecation: @1817078400
Sunset: Tue, 30 Nov 2027 00:00:00 GMT
Link: <https://aoa.com.ua/docs/api-reference/versioning>; rel="deprecation"Tip: log responses that carry a Deprecation header in your integration, so a change never takes you by surprise.