Ändpunktsöversikt
Tabellen nedan återger de offentliga rutterna i backend-public-api/app.js. Sökvägar visas med det offentliga proxyprefix som används av externa integrationer.
| Metod | Ändpunkt | Beskrivning | Åtkomst |
|---|---|---|---|
GET | /public-api/healthz | Hälsokontroll av tjänsten. | offentlig |
GET | /public-api/v1/auth/check | Validerar uppgifter och returnerar butik, behörighetsomfång och planfunktioner. | valfria autentiserade uppgifter |
GET | /public-api/v1/customer-orders | Returnerar en sidindelad och filtrerbar lista över kundbeställningar. | orders:read |
GET | /public-api/v1/customer-orders/:id | Returnerar en kundbeställning med konfigurerade produktartiklar. | orders:read |
POST | /public-api/v1/customer-orders/batch | Returnerar upp till 100 beställningar efter ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Uppdaterar orderstatus. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Uppdaterar antal för valda orderdetaljer. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Anger samma antal för varje artikel i en beställning. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Tar bort en kundbeställning som tillhör butiksägaren. | orders:write |
GET | /public-api/v1/products | Returnerar butiksprodukter/designer med inbäddningstillgänglighet och medieadresser. | products:read |
GET | /public-api/v1/products/:id | Returnerar en butiksprodukt/design. | products:read |
POST | /public-api/v1/embed/session | Utfärdar en kortlivad JWT för inbäddade verktyg, inklusive modellgeneratorn. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Tolkar runtimekontext från en inbäddnings-JWT. | Bearer-token för inbäddning |
GET | /public-api/v1/assets | Listar resurskatalogobjekt av den begärda typen. | valfria autentiserade uppgifter |
GET | /public-api/v1/assets/:type/:assetId | Returnerar ett resursmanifest med nedladdningsbara filroller. | valfria autentiserade uppgifter |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Laddar ner en resursfil efter roll. | valfria autentiserade uppgifter |
GET | /public-api/v1/design-imports | Listar importerbara designer som lagras hos Alter. | autentiserade uppgifter, Business-plan krävs |
GET | /public-api/v1/design-imports/:id | Returnerar designimportens payload och filbeskrivningar. | autentiserade uppgifter, Business-plan krävs |
GET | /public-api/v1/design-imports/:id/files/:fileId | Laddar ner en fil från ett designimportobjekt. | autentiserade uppgifter, Business-plan krävs |
GET | /public-api/v1/file/public/products/:productId/:size | Returnerar en offentlig produktförhandsvisning. Storleken måste vara small.png, medium.png eller big.png. | offentlig |
GET | /public-api/v1/file/protected/:key | Returnerar en skyddad fil efter lagringsnyckel. | signerad URL eller files:read |
GET | /public-api/v1/fonts | Returnerar alla tillgängliga typsnitt. | offentlig |
GET | /public-api/v1/currencies | Returnerar alla valutor. | offentlig |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Skapar eller uppdaterar runtimekopplingar från WordPress-produktkopplingar. | valfria autentiserade uppgifter |
PATCH | /public-api/v1/runtime-bindings/:id | Uppdaterar delar av en runtimekoppling. | valfria autentiserade uppgifter |
POST | /public-api/v1/runtime-bindings/:id/activate | Aktiverar en runtimekoppling. | valfria autentiserade uppgifter |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Inaktiverar en runtimekoppling. | valfria autentiserade uppgifter |
POST | /public-api/v1/wp-connect/exchange | Byter en överlämningskod för automatisk WordPress-anslutning mot API-uppgifter. | engångskod för överlämning |
GET | /public-api/v1/model-generator/catalog | Listar synliga generatorprodukter, konfigurationer och mallrevisioner. | embed:session:create |
GET | /public-api/v1/model-generator/models | Listar modeller med låsta beskrivningar av generatorkällan för import. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Returnerar katalogen med generatormodeller som används av Designer. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Listar ägarens och globalt tillgängliga generatorprojekt. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Returnerar den senaste eller valda projektrevisionen, mallen och filmanifestet. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Returnerar den senaste eller valda projektrevisionen, mallen och filmanifestet. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Laddar ned en resultatfil efter kontroll av åtkomsten till dess projekt. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Returnerar ett tillgängligt malldokument för den valda konfigurationsrevisionen. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Returnerar mallens importpaket med beroendefiler. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Returnerar båda mannequinerna och deras resursbeskrivningar. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Listar resurser från textur- eller bakgrundsbiblioteket med filer som kan importeras. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Returnerar en textur- eller bakgrundsresurs med dess importerbara filer. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Laddar ned en tillåten beroendefil för generatorn. | embed:session:create |