Endpointoversigt
Tabellen nedenfor afspejler de offentlige ruter i backend-public-api/app.js. Stierne vises med det offentlige proxyprefix, som eksterne integrationer bruger.
| Metode | Endpoint | Beskrivelse | Adgang |
|---|---|---|---|
GET | /public-api/healthz | Sundhedskontrol af tjenesten. | offentlig |
GET | /public-api/v1/auth/check | Validerer legitimationsoplysninger og returnerer butik, adgangsomfang og planfunktioner. | vilkårlige godkendte legitimationsoplysninger |
GET | /public-api/v1/customer-orders | Returnerer en sideinddelt og filtrerbar liste over kundeordrer. | orders:read |
GET | /public-api/v1/customer-orders/:id | Returnerer en kundeordre med konfigurerede produktlinjer. | orders:read |
POST | /public-api/v1/customer-orders/batch | Returnerer op til 100 ordrer efter ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Opdaterer ordrestatus. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Opdaterer antal for valgte ordredetaljer. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Angiver samme antal for hver vare i en ordre. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Sletter en kundeordre, der tilhører butiksejeren. | orders:write |
GET | /public-api/v1/products | Returnerer butiksprodukter/designs med indlejringstilgængelighed og medie-URL'er. | products:read |
GET | /public-api/v1/products/:id | Returnerer ét butiksprodukt/design. | products:read |
POST | /public-api/v1/embed/session | Udsteder et kortvarigt JWT til indlejrede værktøjer, herunder modelgeneratoren. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Udleder runtimekontekst fra et indlejrings-JWT. | Bearer-token til indlejring |
GET | /public-api/v1/assets | Viser ressourcekatalogets elementer for den ønskede type. | vilkårlige godkendte legitimationsoplysninger |
GET | /public-api/v1/assets/:type/:assetId | Returnerer et ressourcemanifest med filroller, der kan downloades. | vilkårlige godkendte legitimationsoplysninger |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Downloader en ressourcefil efter rolle. | vilkårlige godkendte legitimationsoplysninger |
GET | /public-api/v1/design-imports | Viser importerbare designs hostet hos Alter. | godkendte legitimationsoplysninger, Business-plan påkrævet |
GET | /public-api/v1/design-imports/:id | Returnerer payload og filbeskrivelser til designimport. | godkendte legitimationsoplysninger, Business-plan påkrævet |
GET | /public-api/v1/design-imports/:id/files/:fileId | Downloader en fil fra en designimportbeskrivelse. | godkendte legitimationsoplysninger, Business-plan påkrævet |
GET | /public-api/v1/file/public/products/:productId/:size | Returnerer en offentlig produktforhåndsvisning. Størrelsen skal være small.png, medium.png eller big.png. | offentlig |
GET | /public-api/v1/file/protected/:key | Returnerer en beskyttet fil efter lagernøgle. | signeret URL eller files:read |
GET | /public-api/v1/fonts | Returnerer alle tilgængelige skrifttyper. | offentlig |
GET | /public-api/v1/currencies | Returnerer alle valutaer. | offentlig |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Opretter eller opdaterer runtimebindinger fra WordPress-produkttilknytninger. | vilkårlige godkendte legitimationsoplysninger |
PATCH | /public-api/v1/runtime-bindings/:id | Opdaterer dele af en runtimebinding. | vilkårlige godkendte legitimationsoplysninger |
POST | /public-api/v1/runtime-bindings/:id/activate | Aktiverer en runtimebinding. | vilkårlige godkendte legitimationsoplysninger |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Deaktiverer en runtimebinding. | vilkårlige godkendte legitimationsoplysninger |
POST | /public-api/v1/wp-connect/exchange | Udveksler en overdragelseskode fra automatisk WordPress-tilslutning med API-legitimationsoplysninger. | engangskode til overdragelse |
GET | /public-api/v1/model-generator/catalog | Viser synlige generatorprodukter, konfigurationer og skabelonrevisioner. | embed:session:create |
GET | /public-api/v1/model-generator/models | Viser modeller med fastlåste beskrivelser af generatorkilden til import. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Returnerer det generatormodelkatalog, som Designer bruger. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Viser ejerens og globalt tilgængelige generatorprojekter. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Returnerer den seneste eller valgte projektrevision, skabelonen og filmanifestet. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Returnerer den seneste eller valgte projektrevision, skabelonen og filmanifestet. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Henter en resultatfil efter at have kontrolleret adgangen til dens projekt. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Returnerer et tilgængeligt skabelondokument for den valgte konfigurationsrevision. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Returnerer skabelonens importpakke med afhængighedsfiler. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Returnerer begge mannequiner og deres ressourcebeskrivelser. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Viser ressourcer fra tekstur- eller baggrundsbiblioteket med filer, der kan importeres. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Returnerer en tekstur- eller baggrundsressource med dens importerbare filer. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Henter en tilladt afhængighedsfil til generatoren. | embed:session:create |