API - Przegląd

API - Lista endpointów

Znajdź endpoint, wymaganą metodę i uprawnienia, a następnie przejdź do szczegółowego przykładu.

Przegląd endpointów

Tabela odzwierciedla publiczne routy montowane w backend-public-api/app.js. Ścieżki pokazują publiczny prefiks reverse proxy używany przez integracje zewnętrzne.

MetodaEndpointOpisDostęp
GET/public-api/healthzHealth check serwisu.publiczny
GET/public-api/v1/auth/checkWaliduje credentiale i zwraca storefront, scope’y oraz możliwości planu.dowolny uwierzytelniony credential
GET/public-api/v1/customer-ordersZwraca paginowaną i filtrowalną listę zamówień klientów.orders:read
GET/public-api/v1/customer-orders/:idZwraca pojedyncze zamówienie klienta ze skonfigurowanymi pozycjami.orders:read
POST/public-api/v1/customer-orders/batchZwraca maksymalnie 100 zamówień na podstawie ID.orders:read
PATCH/public-api/v1/customer-orders/:id/statusAktualizuje status zamówienia.orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantityAktualizuje ilości wybranych pozycji zamówienia.orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantity/allUstawia jedną ilość dla wszystkich pozycji zamówienia.orders:write
DELETE/public-api/v1/customer-orders/:idUsuwa zamówienie klienta należące do właściciela storefrontu.orders:write
GET/public-api/v1/productsZwraca produkty/designy storefrontu z dostępnością embed i URL-ami mediów.products:read
GET/public-api/v1/products/:idZwraca pojedynczy produkt/design storefrontu.products:read
POST/public-api/v1/embed/sessionWystawia krótkotrwały JWT dla osadzonych narzędzi, w tym generatora modeli.embed:session:create
GET/public-api/v1/runtime/bootstrapRozwiązuje kontekst runtime z tokenu embed JWT.token embed Bearer
GET/public-api/v1/assetsListuje assety katalogu dla wskazanego typu.dowolny uwierzytelniony credential
GET/public-api/v1/assets/:type/:assetIdZwraca manifest assetu z rolami plików do pobrania.dowolny uwierzytelniony credential
GET/public-api/v1/assets/:type/:assetId/files/:rolePobiera plik assetu po roli.dowolny uwierzytelniony credential
GET/public-api/v1/design-importsListuje designy dostępne do importu.uwierzytelniony credential, wymagany plan Business
GET/public-api/v1/design-imports/:idZwraca payload importu designu i deskryptory plików.uwierzytelniony credential, wymagany plan Business
GET/public-api/v1/design-imports/:id/files/:fileIdPobiera plik z deskryptora importu designu.uwierzytelniony credential, wymagany plan Business
GET/public-api/v1/file/public/products/:productId/:sizeZwraca publiczny podgląd produktu. Size musi mieć wartość small.png, medium.png albo big.png.publiczny
GET/public-api/v1/file/protected/:keyZwraca chroniony plik po storage key.podpisany URL albo files:read
GET/public-api/v1/fontsZwraca wszystkie dostępne fonty.publiczny
GET/public-api/v1/currenciesZwraca wszystkie waluty.publiczny
POST/public-api/v1/runtime-bindings/sync-from-wordpressTworzy lub aktualizuje runtime bindings z mapowań produktów WordPress.dowolny uwierzytelniony credential
PATCH/public-api/v1/runtime-bindings/:idAktualizuje runtime binding.dowolny uwierzytelniony credential
POST/public-api/v1/runtime-bindings/:id/activateAktywuje runtime binding.dowolny uwierzytelniony credential
POST/public-api/v1/runtime-bindings/:id/deactivateDezaktywuje runtime binding.dowolny uwierzytelniony credential
POST/public-api/v1/wp-connect/exchangeWymienia kod handoff WordPress auto-connect na credentiale API.jednorazowy kod handoff
GET/public-api/v1/model-generator/catalogWyświetla widoczne produkty generatora, konfiguracje i rewizje templatek.embed:session:create
GET/public-api/v1/model-generator/modelsWyświetla modele z deskryptorami wskazującymi konkretne rewizje źródeł generatora do importu.embed:session:create
GET/public-api/v1/model-generator/designer-catalogZwraca katalog modeli generatora używany przez Designera.embed:session:create
GET/public-api/v1/model-generator/projectsWyświetla projekty generatora właściciela oraz dostępne globalnie.embed:session:create
GET/public-api/v1/model-generator/projects/:projectIdZwraca najnowszą lub wskazaną rewizję projektu, templatkę i manifest plików.embed:session:create
GET/public-api/v1/model-generator/projects/:projectId/revisions/:revisionZwraca najnowszą lub wskazaną rewizję projektu, templatkę i manifest plików.embed:session:create
GET/public-api/v1/model-generator/projects/:projectId/artifacts/:artifactIdPobiera artefakt po sprawdzeniu dostępu do jego projektu.embed:session:create
GET/public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/templateZwraca dostępną templatkę dla wybranej rewizji konfiguracji.embed:session:create
GET/public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/importZwraca pakiet importu templatki wraz z plikami zależności.embed:session:create
GET/public-api/v1/model-generator/mannequinsZwraca oba manekiny i deskryptory ich zasobów.embed:session:create
GET/public-api/v1/model-generator/image-libraries/:kind/assetsWyświetla zasoby biblioteki tekstur lub teł wraz z plikami do importu.embed:session:create
GET/public-api/v1/model-generator/image-libraries/:kind/assets/:assetIdZwraca jeden zasób tekstury lub tła wraz z plikami do importu.embed:session:create
GET/public-api/v1/model-generator/public-files/:keyPobiera dozwolony plik zależności generatora.embed:session:create