Saltar al contenido principal
API versioning · transparent

API versioning policy

Semver strict · URL-based versioning · 6 reglas claras · deprecation 12 meses notice mandatory · 8-step deprecation timeline · 6 migration support resources · sunset history transparent. NO breaking changes silenciosos · NO sunset <12m warning.

6 versioning rules

Semver strict · MAJOR.MINOR.PATCH
MAJOR = breaking changes · MINOR = additions backward-compatible · PATCH = bug fixes backward-compatible · NO exceptions
URL-based versioning · /v1/ /v2/
Major version en path URL · /v1/messages vs /v2/messages · co-exist múltiples versiones simultáneamente · NO header versioning (confusing for clients)
Breaking change definition
Cambio que requires client code changes: field removal · type change · endpoint removal · auth method change · response structure change · error format change
Non-breaking change examples
Nueva endpoint · nuevo field opcional response · nuevo enum value (con docs) · performance improvement · bug fix matching documented behavior
Pre-release marking
/v2-beta/ disponible 3+ meses ANTES de promotion v2 stable · feedback window · breaking changes during beta acceptable · documented prominently
Internal API NOT versioned
Internal endpoints (admin · health · webhooks self-callbacks) NOT subject a este versioning · documented separately · clients NO depend internal

Deprecation timeline · 8-step process (12 meses notice)

No client surprises. Cada deprecation sigue mismo flow predictible. 12 meses min entre announcement y sunset.

  1. T-0 · Decision: Deprecate v1 endpoint identified · ADR documented WHY + WHEN replacement available + impact assessment
  2. T+30d · Announcement: Public deprecation notice via /changelog + email registered API users + Twitter status + docs banner ANTES de Sunset announcement
  3. T+90d · Sunset announcement: Specific sunset date 12m future committed · migration guide published with code examples old vs new
  4. T+120d · Migration assistance: Office hours support migrations · 1:1 customer success calls Enterprise clients · changelog updates
  5. T+180d · Half-way reminder: 6 months remaining notice · usage analytics shared with high-volume clients · personalized migration path
  6. T+270d · 90-day warning: 3 months remaining · escalating notifications · status page degraded labeled v1
  7. T+330d · 30-day warning: Final notice · clients NOT migrated identified · personalized outreach · last chance migration help
  8. T+365d · Sunset: v1 endpoint returns 410 Gone status · responseBody includes migration guide URL + support contact · audit log every call attempted to deprecated

6 migration support resources

Migration guides
Per-endpoint old-vs-new comparison · code examples (curl + JS + Python + PHP) · breaking changes highlighted · before/after JSON payloads
Compatibility shim (optional)
Para breaking changes mayor impact · proxy automático v1→v2 disponible 6m post-sunset · degraded performance pero functional · charges higher tier
1:1 office hours
Enterprise clients · weekly 30min calls scheduled · founder personalmente atiende · screen-share + code review migration
Changelog detallado
/changelog página + RSS feed · structured cambios MAJOR/MINOR/PATCH · linked to migration guides · searchable historical
Postman/OpenAPI specs versioned
Cada major version Postman collection + OpenAPI 3.1 spec downloadable · auto-generated SDKs · types up-to-date
Status page deprecation tracking
Per-endpoint status: Active · Deprecated · Sunset Date · Sunset Reason · Replacement · monitoring traffic to deprecated tracked

Sunset history · transparente

VersionDeprecatedSunsetImpactLessons
v0.x (pre-stable)2026-01-15Active beta only · NEVER promoted stable · sunset trivial0 clientes externos (pre-revenue · solo demo internal)Pre-stable APIs NO se commit públicamente · solo experimental
v1 (current stable)Not yet deprecatedTBD · earliest 2027 · 12m+ noticeTBD · plan when v2 announcedv1 long-term support committed · migrations slow rollout planned
v2 (future planned)N/A · futuroN/A · futuroPre-tracción · scope limitedv2 si emerge customer demand · NO speculative
Pre-revenue reality · committed before clients

Esta política pública se compromete ANTES de tener clientes externos API · NO post-hoc. Razón: cliente Enterprise procurement security/integration team valida API stability commitment · ver written policy es señal seriedad.

Caveats honest: 12m deprecation notice asume clients integrados · si pre-tracción NO hay clients integrados · políticas commitment para futuro · serán probadas con primer cliente API integration real.

¿Tu engineering team necesita API integration guide?

Para clientes Enterprise · OpenAPI 3.1 spec completa · Postman collection · code samples 4 idiomas · webhook signatures + retry logic detalle disponibles bajo NDA Enterprise.