Endpointoverzicht
De onderstaande tabel komt overeen met de openbare routes in backend-public-api/app.js. De paden bevatten het openbare proxyvoorvoegsel voor externe integraties.
| Methode | Endpoint | Beschrijving | Toegang |
|---|---|---|---|
GET | /public-api/healthz | Statuscontrole van de service. | openbaar |
GET | /public-api/v1/auth/check | Valideert inloggegevens en retourneert de winkel, machtigingen en planmogelijkheden. | alle geauthenticeerde inloggegevens |
GET | /public-api/v1/customer-orders | Retourneert een gepagineerde en filterbare lijst met klantbestellingen. | orders:read |
GET | /public-api/v1/customer-orders/:id | Retourneert één klantbestelling met geconfigureerde productartikelen. | orders:read |
POST | /public-api/v1/customer-orders/batch | Retourneert maximaal 100 bestellingen op ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Werkt de bestelstatus bij. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Werkt de aantallen van geselecteerde besteldetails bij. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Stelt één aantal in voor elk artikel in een bestelling. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Verwijdert een klantbestelling die eigendom is van de winkeleigenaar. | orders:write |
GET | /public-api/v1/products | Retourneert winkelproducten/ontwerpen met integratiemogelijkheden en media-URL's. | products:read |
GET | /public-api/v1/products/:id | Retourneert één winkelproduct/ontwerp. | products:read |
POST | /public-api/v1/embed/session | Geeft een kort geldig JWT uit voor ingesloten tools, waaronder de modelgenerator. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Bepaalt de runtimecontext op basis van een embed-JWT. | Bearer-embedtoken |
GET | /public-api/v1/assets | Toont assetcatalogusitems van het aangevraagde type. | alle geauthenticeerde inloggegevens |
GET | /public-api/v1/assets/:type/:assetId | Retourneert een assetmanifest met downloadbare bestandsrollen. | alle geauthenticeerde inloggegevens |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Downloadt een assetbestand op basis van de rol. | alle geauthenticeerde inloggegevens |
GET | /public-api/v1/design-imports | Toont importeerbare ontwerpen uit Alter-opslag. | geauthenticeerde inloggegevens, Business-plan vereist |
GET | /public-api/v1/design-imports/:id | Retourneert een ontwerpimportpayload en bestandsbeschrijvingen. | geauthenticeerde inloggegevens, Business-plan vereist |
GET | /public-api/v1/design-imports/:id/files/:fileId | Downloadt een bestand uit een ontwerpimportbeschrijving. | geauthenticeerde inloggegevens, Business-plan vereist |
GET | /public-api/v1/file/public/products/:productId/:size | Retourneert een openbaar productvoorbeeld. De grootte moet small.png, medium.png of big.png zijn. | openbaar |
GET | /public-api/v1/file/protected/:key | Retourneert een beveiligd bestand op basis van de opslagsleutel. | ondertekende URL of files:read |
GET | /public-api/v1/fonts | Retourneert alle beschikbare lettertypen. | openbaar |
GET | /public-api/v1/currencies | Retourneert alle valuta's. | openbaar |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Maakt of actualiseert runtimekoppelingen op basis van WordPress-productkoppelingen. | alle geauthenticeerde inloggegevens |
PATCH | /public-api/v1/runtime-bindings/:id | Werkt een runtimekoppeling gedeeltelijk bij. | alle geauthenticeerde inloggegevens |
POST | /public-api/v1/runtime-bindings/:id/activate | Activeert een runtimekoppeling. | alle geauthenticeerde inloggegevens |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Deactiveert een runtimekoppeling. | alle geauthenticeerde inloggegevens |
POST | /public-api/v1/wp-connect/exchange | Wisselt een overdrachtscode voor automatisch verbinden met WordPress in voor API-inloggegevens. | eenmalige overdrachtscode |
GET | /public-api/v1/model-generator/catalog | Toont zichtbare generatorproducten, configuraties en sjabloonrevisies. | embed:session:create |
GET | /public-api/v1/model-generator/models | Toont modellen met descriptors die voor import naar specifieke generatorbronrevisies verwijzen. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Retourneert de catalogus met generatormodellen die Designer gebruikt. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Toont de generatorprojecten van de eigenaar en wereldwijd beschikbare projecten. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Retourneert de nieuwste of geselecteerde projectrevisie, het sjabloon en het bestandsmanifest. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Retourneert de nieuwste of geselecteerde projectrevisie, het sjabloon en het bestandsmanifest. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Downloadt een artefact nadat de toegang tot het bijbehorende project is gecontroleerd. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Retourneert een toegankelijk sjabloondocument voor de geselecteerde configuratierevisie. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Retourneert het importpakket van het sjabloon met de afhankelijkheidsbestanden. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Retourneert beide mannequins en de descriptors van hun bronnen. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Toont assets uit de textuur- of achtergrondbibliotheek met importeerbare bestanden. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Retourneert één textuur- of achtergrondasset met de bijbehorende importeerbare bestanden. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Downloadt een toegestaan afhankelijkheidsbestand van de generator. | embed:session:create |