Endepunktoversikt
Tabellen nedenfor gjenspeiler de offentlige rutene i backend-public-api/app.js. Stiene vises med det offentlige proxyprefikset som brukes av eksterne integrasjoner.
| Metode | Endepunkt | Beskrivelse | Tilgang |
|---|---|---|---|
GET | /public-api/healthz | Helsekontroll av tjenesten. | offentlig |
GET | /public-api/v1/auth/check | Validerer legitimasjon og returnerer butikk, tilgangsomfang og abonnementsfunksjoner. | enhver autentisert legitimasjon |
GET | /public-api/v1/customer-orders | Returnerer en paginert og filtrerbar liste med kundebestillinger. | orders:read |
GET | /public-api/v1/customer-orders/:id | Returnerer én kundebestilling med konfigurerte produktlinjer. | orders:read |
POST | /public-api/v1/customer-orders/batch | Returnerer opptil 100 bestillinger etter ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Oppdaterer bestillingsstatusen. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Oppdaterer antallet for valgte bestillingsdetaljer. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Angir samme antall for hver vare i en bestilling. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Sletter en kundebestilling som tilhører butikkeieren. | orders:write |
GET | /public-api/v1/products | Returnerer butikkprodukter/design med tilgjengelighet for innebygging og medie-URL-er. | products:read |
GET | /public-api/v1/products/:id | Returnerer ett butikkprodukt/design. | products:read |
POST | /public-api/v1/embed/session | Utsteder et kortvarig JWT for innebygde verktøy, inkludert modellgeneratoren. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Finner runtimekontekst fra et innebyggings-JWT. | Bearer-innebyggingstoken |
GET | /public-api/v1/assets | Lister ressurskatalogelementer av forespurt type. | enhver autentisert legitimasjon |
GET | /public-api/v1/assets/:type/:assetId | Returnerer et ressursmanifest med nedlastbare filroller. | enhver autentisert legitimasjon |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Laster ned en ressursfil etter rolle. | enhver autentisert legitimasjon |
GET | /public-api/v1/design-imports | Lister importerbare design lagret hos Alter. | autentisert legitimasjon, Business-abonnement kreves |
GET | /public-api/v1/design-imports/:id | Returnerer designimportpayload og filbeskrivelser. | autentisert legitimasjon, Business-abonnement kreves |
GET | /public-api/v1/design-imports/:id/files/:fileId | Laster ned en fil fra en designimportbeskrivelse. | autentisert legitimasjon, Business-abonnement kreves |
GET | /public-api/v1/file/public/products/:productId/:size | Returnerer en offentlig produktforhåndsvisning. Størrelsen må være small.png, medium.png eller big.png. | offentlig |
GET | /public-api/v1/file/protected/:key | Returnerer en beskyttet fil etter lagringsnøkkel. | signert URL eller files:read |
GET | /public-api/v1/fonts | Returnerer alle tilgjengelige skrifter. | offentlig |
GET | /public-api/v1/currencies | Returnerer alle valutaer. | offentlig |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Oppretter eller oppdaterer runtimekoblinger fra WordPress-produktkoblinger. | enhver autentisert legitimasjon |
PATCH | /public-api/v1/runtime-bindings/:id | Oppdaterer en runtimekobling delvis. | enhver autentisert legitimasjon |
POST | /public-api/v1/runtime-bindings/:id/activate | Aktiverer en runtimekobling. | enhver autentisert legitimasjon |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Deaktiverer en runtimekobling. | enhver autentisert legitimasjon |
POST | /public-api/v1/wp-connect/exchange | Bytter en overføringskode for automatisk WordPress-tilkobling mot API-legitimasjon. | engangskode for overføring |
GET | /public-api/v1/model-generator/catalog | Viser synlige generatorprodukter, konfigurasjoner og malrevisjoner. | embed:session:create |
GET | /public-api/v1/model-generator/models | Viser modeller med deskriptorer som fastsetter bestemte kilderevisjoner av generatoren for import. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Returnerer generatorens modellkatalog som brukes av Designer. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Viser eierens og globalt tilgjengelige generatorprosjekter. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Returnerer den nyeste eller valgte prosjektrevisjonen, malen og filmanifestet. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Returnerer den nyeste eller valgte prosjektrevisjonen, malen og filmanifestet. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Laster ned en artefakt etter å ha kontrollert tilgang til prosjektet den tilhører. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Returnerer et tilgjengelig maldokument for den valgte konfigurasjonsrevisjonen. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Returnerer importpakken for malen med tilhørende avhengighetsfiler. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Returnerer begge mannekengene og ressursdeskriptorene deres. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Viser ressurser fra tekstur- eller bakgrunnsbiblioteket med filer som kan importeres. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Returnerer én tekstur- eller bakgrunnsressurs med tilhørende filer som kan importeres. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Laster ned en tillatt avhengighetsfil for generatoren. | embed:session:create |