Skip to main content
Strony w tej zakładce są generowane z specyfikacji OpenAPI. Każdy endpoint ma interaktywny formularz „Wypróbuj”.

​
Bazowy URL

Lokalnie: http://localhost:3000/api/v2. Wszystkie ścieżki mają prefiks /api/v2.

​
Uwierzytelnianie

Endpoint może wymagać sesji bearerAuth, klucza sklepu apiKeyAuth, akceptować oba mechanizmy albo być publiczny. Dla klucza:
Jeśli endpoint dopuszcza klucz i żądanie zawiera oba mechanizmy, sprawdzany jest klucz. Zwykła trasa Bearer ignoruje klucz i używa sesji. Szczegóły: Uwierzytelnianie.

​
Konwencje odpowiedzi

Sukces ma kształt { success: true, data, message? }, błąd { success: false, statusCode, error, timestamp, path }. Zawsze sprawdzaj pole success. Zobacz Obsługę błędów.

​
Identyfikatory

Identyfikatory zasobów (shopId, serverId, orderId, …) to MongoDB ObjectId — 24-znakowy hex (^[0-9a-fA-F]{24}$). Nieprawidłowy format zwraca 400.

​
Endpointy publiczne

Część endpointów nie wymaga uwierzytelnienia: tworzenie zamówienia, publiczne katalogi, realizacja vouchera, walidacja kodu rabatowego oraz webhooki płatności. W API reference mają oznaczenie braku zabezpieczeń.