Skip to main content
ItemShop v2 to API platformy, na której właściciele serwerów Minecraft prowadzą sklepy z przedmiotami. Jeden użytkownik może mieć wiele sklepów, każdy sklep wiele serwerów, a klienci kupują produkty i otrzymują je w grze przez wtyczkę. API jest zbudowane na NestJS 11 z adapterem Fastify 5. Wszystkie ścieżki mają prefiks /api/v2.

Główne pojęcia

Sklep (shop)

Jednostka organizacyjna. Ma właściciela, przypisanych użytkowników z rolami (view/edit/full), własną konfigurację płatności, VAT, e-maili i Discorda.

Serwer (server)

Serwer Minecraft powiązany ze sklepem. Produkty przypisuje się do serwera; plugin odbiera dla niego dostawy w czasie rzeczywistym.

Produkt (product)

Pozycja w katalogu z ceną i listą komend do wykonania (z placeholderami {PLAYER}, {QUANTITY}, {PRODUCT}).

Zamówienie (order)

Tworzone publicznie przez klienta. Generuje sesję płatności; po opłaceniu trafia do realizacji przez wtyczkę.

Cykl życia zamówienia

1

Utworzenie

Klient wysyła POST /orders z produktem, nickiem i metodą płatności. API tworzy zamówienie i sesję płatności, zwraca link do płatności.
2

Płatność

Klient płaci u dostawcy. Dostawca wysyła webhook na POST /payments/webhooks/.... Po weryfikacji podpisu zamówienie przechodzi w status paid.
3

Realizacja

Plugin Minecraft odbiera push Socket.IO, wygrywa atomowy claim, zapisuje journal, wykonuje sformatowane komendy i potwierdza realizację (statuscompleted).

Co dalej

Szybki start

Pierwsze żądania: rejestracja, sklep, produkt, zamówienie.

Architektura

Struktura modułów, warstwy, integracje (Redis, kolejki, WebSocket).

Uwierzytelnianie

Klucze API, uprawnienia i role.

API Reference

Pełna lista endpointów wygenerowana z OpenAPI.