AutoApply SA / Developers

API versioning and deprecation policy

Public API versions appear in the URL path, for example /api/v1/product. Backward-compatible additions may be made within a version. A breaking change will use a new major URL version.

Deprecation notice

AutoApply SA will give at least six months’ notice before retiring a published API version, except where an urgent security, legal, or operational issue requires a shorter period. A notice will identify affected endpoints, the replacement, and the retirement date.

Response signals

When an endpoint is formally deprecated, responses will include the standard Deprecation header with the deprecation date and a Sunset header with the planned retirement date, plus a Link header pointing to this policy. Active endpoints will not include deprecation headers. Current v1 endpoints are active and have no announced sunset date.

Client guidance

Read the response headers and this page periodically. Switch to the documented replacement before the announced sunset date. Rate-limit headers are advisory signals; on HTTP 429, follow Retry-After.

OpenAPI specification · Developer documentation