Versiebeheer

Wat er in v1 kan veranderen

Alleen aanvullende wijzigingen: nieuwe routes, nieuwe optionele verzoekvelden, nieuwe responsevelden, nieuwe enumwaarden in antwoorden, nieuwe foutredenen, nieuwe webhookgebeurtenissen en payloadvelden. Schrijf clients die onbekende velden negeren en onbekende enumwaarden tolereren.

Een brekende wijziging is een nieuwe hoofdversie (/v2) naast v1.

Afschaffing

Een route of veld kan worden afgeschaft, nooit ter plekke gewijzigd. Vanaf de dag van afschaffing draagt elk antwoord dat eraan raakt Deprecation: @<unix seconds> (RFC 9745), Sunset: <HTTP date> (RFC 8594) en een Link naar de changelog-vermelding met rel="deprecation". Het blijft daarna minstens 365 dagen werken.

Log of alarmeer op de Deprecation-header en je hoort van elke afschaffing lang voordat het ertoe doet. Elke staat in de changelog.

Webhook-payloads

Webhook-payloads zijn op datum geversioneerd (nu 2026-09-01). Elk endpoint houdt de payloadversie waarmee het is gemaakt, dus een toekomstige brekende wijziging van een payload bereikt alleen endpoints die daarvoor kiezen.