Obsługa wersji

Z tego przewodnika dowiesz się, jak Merchant API obsługuje wersje, wydania i cykl życia różnych wersji.

Schemat obsługi wersji

Merchant API stosuje strategię obsługi wersji na poziomie podrzędnego interfejsu API. Oznacza to, że każdy interfejs Merchant API, np. Produkty w Merchant API, będzie miał własny cykl życia wersji.

Format i prezentacja wersji

• Stabilne wersje podrzędnego interfejsu API: jeśli podrzędny interfejs API jest w wersji stabilnej, wszystkie jego metody są w wersji stabilnej. Stabilna wersja podrzędnego interfejsu API jest oznaczona jako vX (np. v1, v2). Są to główne wersje gotowe do użycia w środowisku produkcyjnym.

• Wersje alfa podrzędnego interfejsu API: jeśli podrzędny interfejs API jest w wersji alfa, wszystkie jego metody są w wersji alfa. Wersja alfa podrzędnego interfejsu API jest oznaczona jako vXalpha (np. v1alpha, v2alpha). Zawierają one eksperymentalne funkcje z wczesnym dostępem, które są przeznaczone do testowania i szybkiego wprowadzania zmian. Wersje alfa nie zapewniają stabilności, nie mają określonego okresu ważności i mogą zostać zmienione lub wycofane z 30-dniowym wyprzedzeniem.

Zmiany wersji

• Zwiększenie numeru wersji głównej (np. z v1 na v2): sygnalizuje zmiany powodujące niezgodność wsteczną i zmiany powodujące niezgodność, które wymagają działania dewelopera. Nowy numer wersji będą miały tylko zmiany powodujące niezgodność stabilnych podrzędnych interfejsów API. Na przykład z v1 na v2.
• Drobne zmiany: dodatki lub poprawki zgodne wstecznie są prezentowane jako zmiany w istniejącej wersji głównej. Takie zmiany zostaną szczegółowo opisane w informacjach o wersji głównej. Dodatki do podrzędnego interfejsu API, które nie powodują niezgodności, zostaną opublikowane w kanale alfa najnowszej wersji stabilnej lub bezpośrednio w najnowszej wersji stabilnej.

Zasady wycofywania

Okresowo wycofujemy starsze wersje podrzędnych interfejsów Merchant API. Zobowiązujemy się do 12-miesięcznego okresu wycofywania stabilnych wersji głównych (vX), licząc od oficjalnego ogłoszenia o wycofaniu.

Jeśli na przykład 15 stycznia 2026 r. wycofamy wersję 1 podrzędnego interfejsu Products API, zostanie ona wycofana nie wcześniej niż 15 stycznia 2027 r. Po tej dacie wcześniejsza wersja podrzędnego interfejsu API nie będzie już dostępna.

Wersja podrzędnego interfejsu API i stan cyklu życia

W tabeli poniżej znajdziesz najnowsze wersje każdego podrzędnego interfejsu Merchant API:

Sprawdzone metody

• Regularnie sprawdzaj informacje o wersji i najnowsze aktualizacje aby dowiedzieć się o nowych wersjach, głównych aktualizacjach, ulepszeniach oraz ogłoszeniach dotyczących uruchamiania i wycofywania podrzędnych interfejsów API.
• Jeśli podrzędny interfejs API ma co najmniej 2 stabilne wersje, zalecamy korzystanie z najnowszej wersji.
• Zaprojektuj aplikację tak, aby prawidłowo obsługiwała różne błędy podrzędnego interfejsu API, w tym problemy z siecią, limity liczby żądań oraz nowe kody błędów lub komunikaty, które mogą zostać wprowadzone w nowszych wersjach podrzędnego interfejsu API.
• Nie czekaj, aż wersja podrzędnego interfejsu API zostanie wycofana, aby rozpocząć planowanie aktualizacji. Zacznij oceniać i testować nowe wersje, gdy tylko będą dostępne.
• Jeśli masz prośby o dodanie funkcji lub obawy dotyczące planu rozwoju podrzędnego interfejsu API, skontaktuj się z nami , aby zadać pytania lub podzielić się opinią. Informacje o tym, jak skontaktować się z zespołem Merchant API w celu uzyskania pomocy technicznej , znajdziesz w artykule Uzyskiwanie pomocy dotyczącej Merchant API.