Wersjonowanie

Co może się zmienić w v1

Tylko zmiany addytywne: nowe trasy, nowe opcjonalne pola żądań, nowe pola odpowiedzi, nowe wartości enum w odpowiedziach, nowe przyczyny błędów, nowe zdarzenia webhooków i pola payloadu. Pisz klientów, którzy ignorują nieznane pola i tolerują nieznane wartości enum.

Zmiana łamiąca to nowa wersja główna (/v2) udostępniana obok v1.

Wycofywanie

Trasa lub pole może zostać wycofane, nigdy zmienione w miejscu. Od dnia wycofania każda odpowiedź, której to dotyczy, niesie Deprecation: @<unix seconds> (RFC 9745), Sunset: <HTTP date> (RFC 8594) i Link do wpisu w changelogu z rel="deprecation". Nadal działa przez co najmniej 365 dni po tym dniu.

Loguj nagłówek Deprecation lub ustaw na niego alert, a o każdym wycofaniu dowiesz się na długo, zanim będzie miało znaczenie. Każde jest wymienione w changelogu.

Payloady webhooków

Payloady webhooków są wersjonowane datą (dziś 2026-09-01). Każdy endpoint zachowuje wersję payloadu, z którą został utworzony, więc przyszła zmiana łamiąca payload dotrze tylko do endpointów, które się na nią zdecydują.