Přehled koncových bodů
Následující tabulka odpovídá veřejným trasám připojeným v backend-public-api/app.js. Cesty obsahují veřejný prefix proxy používaný externími integracemi.
| Metoda | Koncový bod | Popis | Přístup |
|---|---|---|---|
GET | /public-api/healthz | Kontrola dostupnosti služby. | veřejný |
GET | /public-api/v1/auth/check | Ověřuje přístupové údaje a vrací obchod, rozsahy oprávnění a možnosti tarifu. | libovolné ověřené přístupové údaje |
GET | /public-api/v1/customer-orders | Vrací stránkovaný a filtrovatelný seznam objednávek zákazníků. | orders:read |
GET | /public-api/v1/customer-orders/:id | Vrací jednu objednávku zákazníka s nakonfigurovanými položkami produktů. | orders:read |
POST | /public-api/v1/customer-orders/batch | Vrací až 100 objednávek podle ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Aktualizuje stav objednávky. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Aktualizuje množství vybraných položek objednávky. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Nastavuje stejné množství pro každou položku objednávky. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Odstraňuje objednávku zákazníka patřící vlastníkovi obchodu. | orders:write |
GET | /public-api/v1/products | Vrací produkty/návrhy obchodu s dostupností vložení a URL médií. | products:read |
GET | /public-api/v1/products/:id | Vrací jeden produkt/návrh obchodu. | products:read |
POST | /public-api/v1/embed/session | Vydává krátkodobý JWT pro vložené nástroje, včetně generátoru modelů. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Zjišťuje kontext běhového prostředí z JWT vloženého nástroje. | token vloženého nástroje Bearer |
GET | /public-api/v1/assets | Vypisuje položky katalogu podkladů požadovaného typu. | libovolné ověřené přístupové údaje |
GET | /public-api/v1/assets/:type/:assetId | Vrací manifest podkladu s rolemi souborů ke stažení. | libovolné ověřené přístupové údaje |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Stahuje soubor podkladu podle role. | libovolné ověřené přístupové údaje |
GET | /public-api/v1/design-imports | Vypisuje návrhy hostované v Alter Product, které lze importovat. | ověřené přístupové údaje, vyžadován tarif Business |
GET | /public-api/v1/design-imports/:id | Vrací data importu návrhu a popisy souborů. | ověřené přístupové údaje, vyžadován tarif Business |
GET | /public-api/v1/design-imports/:id/files/:fileId | Stahuje soubor z popisu importu návrhu. | ověřené přístupové údaje, vyžadován tarif Business |
GET | /public-api/v1/file/public/products/:productId/:size | Vrací veřejný náhled produktu. Size musí být small.png, medium.png nebo big.png. | veřejný |
GET | /public-api/v1/file/protected/:key | Vrací chráněný soubor podle klíče úložiště. | podepsané URL nebo files:read |
GET | /public-api/v1/fonts | Vrací všechna dostupná písma. | veřejný |
GET | /public-api/v1/currencies | Vrací všechny měny. | veřejný |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Vytváří nebo aktualizuje vazby běhového prostředí podle propojení produktů WordPressu. | libovolné ověřené přístupové údaje |
PATCH | /public-api/v1/runtime-bindings/:id | Aktualizuje vazbu běhového prostředí. | libovolné ověřené přístupové údaje |
POST | /public-api/v1/runtime-bindings/:id/activate | Aktivuje vazbu běhového prostředí. | libovolné ověřené přístupové údaje |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Deaktivuje vazbu běhového prostředí. | libovolné ověřené přístupové údaje |
POST | /public-api/v1/wp-connect/exchange | Vyměňuje předávací kód automatického připojení WordPressu za přístupové údaje API. | jednorázový předávací kód |
GET | /public-api/v1/model-generator/catalog | Zobrazuje viditelné produkty generátoru, konfigurace a revize šablon. | embed:session:create |
GET | /public-api/v1/model-generator/models | Zobrazuje modely s deskriptory určujícími konkrétní zdrojové revize generátoru pro import. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Vrací katalog modelů generátoru používaný Designerem. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Zobrazuje projekty generátoru vlastníka i globálně dostupné projekty. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Vrací nejnovější nebo vybranou revizi projektu, šablonu a manifest souborů. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Vrací nejnovější nebo vybranou revizi projektu, šablonu a manifest souborů. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Stáhne artefakt po ověření přístupu k jeho projektu. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Vrací přístupný dokument šablony pro vybranou revizi konfigurace. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Vrací balíček pro import šablony se soubory závislostí. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Vrací obě figuríny a deskriptory jejich zdrojů. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Zobrazuje podklady knihovny textur nebo pozadí se soubory k importu. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Vrací jeden podklad textury nebo pozadí se soubory k importu. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Stáhne povolený soubor závislosti generátoru. | embed:session:create |