Z tego przewodnika dowiesz się, jak interfejs Merchant API obsługuje wersje, wydania i cykl życia różnych wersji.
Schemat obsługi wersji
Interfejs Merchant API stosuje strategię obsługi wersji na poziomie podrzędnego interfejsu API. Oznacza to, że każdy interfejs Merchant API, na przykład Products w Merchant API, będzie miał własny cykl życia wersji.
Format i prezentacja wersji
Wersje stabilne podrzędnych interfejsów 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 wersje główne gotowe do wykorzystania w środowisku produkcyjnym.
Wersje alfa podrzędnych interfejsów API: jeśli podrzędny interfejs API jest w wersji alfa, wszystkie jego metody są w wersji alfa. Wersja podrzędnego interfejsu API w wersji alfa jest reprezentowana jako vXalpha (np. v1alpha, v2alpha). Zawierają eksperymentalne funkcje z wcześniejszym dostępem, które są przeznaczone do testowania i szybkiej iteracji. Wersje alfa nie gwarantują stabilności, nie mają określonego okresu ważności i mogą zostać zmienione lub wycofane z 30-dniowym okresem wypowiedzenia.
Zmiany wersji
- Zwiększenie numeru wersji głównej (np. z wersji 1 do wersji 2): oznacza zmiany powodujące niezgodność wsteczną i zmiany powodujące niezgodność, co wymaga działania ze strony dewelopera. Nowy numer wersji będą miały tylko zmiany powodujące niezgodność w stabilnych podrzędnych interfejsach API. Na przykład z wersji 1 na wersję 2.
- Drobne zmiany: zgodne wstecznie dodatki lub poprawki są przedstawiane 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ą błędów, będą udostępniane w kanale alfa najnowszej wersji stabilnej lub bezpośrednio w najnowszej wersji stabilnej.
Zasady dotyczące wycofywania
Okresowo wycofujemy starsze wersje podrzędnych interfejsów API sprzedawcy. Zobowiązujemy się do zapewnienia 12-miesięcznego okresu wycofywania stabilnych wersji głównych (vX), liczonego od oficjalnego ogłoszenia o wycofaniu.
Jeśli na przykład 15 stycznia 2026 r. wycofamy wersję 1 podrzędnego interfejsu API Products, zostanie ona wyłączona 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 poszczególnych podinterfejsów API Merchant API:
| Sub-API | Wersje | Stan |
|---|---|---|
| Konta | v1 v1alpha |
Aktywne Aktywne |
| Konwersje | v1 | Aktywne |
| Źródła danych | v1 | Aktywne |
| Zasoby reklamowe | v1 | Aktywne |
| Rozwiązywanie problemów | v1 | Aktywne |
| Program partnerski danych o asortymencie lokalnym | v1 | Aktywne |
| Powiadomienia | v1 | Aktywne |
| śledzonych zamówień, | v1 | Aktywne |
| Produkty | v1 | Aktywne |
| Product Studio | v1alpha | Aktywne |
| Promocje | v1 | Aktywne |
| Limit | v1 | Aktywne |
| Raporty | v1 | Aktywne |
| Opinie | v1alpha | Aktywne |
Sprawdzone metody
- Regularnie sprawdzaj informacje o wersji i najnowsze aktualizacje, aby dowiedzieć się o nowych wersjach, dużych aktualizacjach, ulepszeniach i ogłoszeniach dotyczących uruchomienia i wycofania podrzędnych interfejsów API.
- Jeśli podrzędny interfejs API ma co najmniej 2 wersje stabilne, zalecamy korzystanie z najnowszej wersji.
- Zaprojektuj aplikację tak, aby prawidłowo obsługiwała różne błędy podrzędnych interfejsów API, w tym problemy z siecią, ograniczanie liczby żądań oraz nowe kody błędów lub komunikaty, które mogą zostać wprowadzone w nowszych wersjach podrzędnych interfejsów API.
- Nie czekaj z planowaniem uaktualnienia do momentu, gdy wersja podrzędnego interfejsu API zostanie wycofana. Zacznij oceniać i testować nowe wersje, gdy tylko będą dostępne.
- Jeśli masz prośby o dodanie funkcji lub wątpliwości dotyczące planu rozwoju podrzędnego interfejsu API, skontaktuj się z nami, aby zadać pytania lub przekazać opinię. Informacje o tym, jak skontaktować się z zespołem Merchant API w celu uzyskania pomocy technicznej, znajdziesz w artykule Jak uzyskać pomoc dotyczącą interfejsu API sprzedawcy.