API Design

API Versioning: Never Break a Client Configuration

September 15, 2024
API Versioning: Never Break a Client Configuration

When an enterprise builds a pipeline on top of your API, modifying a JSON key can break millions of dollars of infrastructure. We approach API design with extreme caution.

URL Versioning vs Header Versioning

We route our API traffic using strict date-based headers (e.g., Achtrex-Version: 2024-09-15). This allows us to push breaking changes to newer routes while the old proxy routes silently translate payloads for legacy clients.