Pobierz kontrakt API

Wkrótce

Udostępnimy tu wersjonowany, maszynowo-czytelny kontrakt API — jeden plik opisujący wszystkie zasoby, operacje, schematy pól i kody odpowiedzi Commerce API. To jedno źródło prawdy dla integracji: na jego podstawie wygenerujesz klienta w swoim języku i zwalidujesz żądania oraz odpowiedzi.

Co udostępnimy

• Kontrakt do pobrania — kompletny opis endpointów, parametrów i schematów w jednym pliku, gotowy do użycia w narzędziach.
• Wersja i suma kontrolna — każde wydanie kontraktu ma jednoznaczną wersję oraz sumę kontrolną (checksum), dzięki czemu potwierdzisz integralność i dokładnie wiesz, którą wersję integrujesz.
• Zgodność z referencją — strony referencji w tym portalu powstają z tego samego kontraktu, więc dokumentacja i plik nigdy się nie rozjeżdżają.

Wersja i suma kontrolna

Zanim wdrożysz nową wersję, porównaj sumę kontrolną pobranego pliku z wartością publikowaną przy wydaniu. Wersję kontraktu przypinasz po swojej stronie, aby aktualizacje wprowadzać świadomie, a nie automatycznie. Zasady wersjonowania i wycofywania pól opisujemy w Dzienniku zmian.

Zastosowanie

• Generowanie klientów (codegen) — z kontraktu wygenerujesz typy i klienta w wybranym języku. Nie udostępniamy oficjalnego SDK — pracujesz na własnym kliencie wygenerowanym z kontraktu.
• Walidacja — użyjesz kontraktu do walidacji żądań i odpowiedzi w testach integracyjnych oraz w bramkach CI.
• Dokumentacja wewnętrzna — zaimportujesz plik do własnych narzędzi przeglądania API.