Wersjonowanie
API dla sprzedawcy i jego dokumenty są w wersji 1, a w ramach v1 tylko rosną. Integracja napisana pod v1 nadal działa.
Ścieżki, nazwy pól, kody błędów, nazwy nagłówków i przykłady kodu pozostają po angielsku: to jest kontrakt.
Co może się zmienić w ramach v1
- Nowe opcjonalne pole w odpowiedzi, żądaniu lub dokumencie zamówienia.
- Nowa trasa, nowy kod błędu, nowe zdarzenie webhooka lub nowa wartość na liście dozwolonych wartości.
- Nowy schemat podpisu obok
v1=wCutOptim-Signature; odbiorniki ignorują schematy, których nie znają.
Co nigdy się nie zmienia w ramach v1
- Żadne pole nie znika, nie zmienia nazwy ani znaczenia.
- Żadna trasa nie zmienia ścieżki, klucza ani kształtu odpowiedzi.
- Kod błędu zachowuje swoje znaczenie.
Napisz tolerancyjny parser
Ignoruj pola, których nie znasz, nieznany kod błędu traktuj według jego statusu HTTP, a typ zdarzenia webhooka, którego nie subskrybujesz, przyjmuj odpowiedzią 2xx. schemaVersion dokumentu zamówienia i każdej treści webhooka wynosi 1.
Zmiana łamiąca zgodność
Zmianą łamiącą zgodność byłby nowy dokument (order.v2) lub nowa ścieżka (/cfg/v2) obok v1, nigdy przepisanie v1. Zostałaby ogłoszona w Dzienniku zmian.
Nie ma tu przycisku „wypróbuj” celowo: klucz tajny należy do Twojego serwera, nigdy do przeglądarki. Sklep demonstracyjny pokazuje osadzenie i przekazanie zamówienia działające od początku do końca.
Informacje prawneWarunki konfiguratora (EN) ·Umowa powierzenia przetwarzania danych (EN) ·Informacja o prywatności dla kupujących ·Licencje stron trzecich (EN)