Endpunktübersicht
Die folgende Tabelle entspricht den in backend-public-api/app.js eingebundenen öffentlichen Routen. Pfade enthalten das öffentliche Proxy-Präfix für externe Integrationen.
| Methode | Endpunkt | Beschreibung | Zugriff |
|---|---|---|---|
GET | /public-api/healthz | Statusprüfung des Dienstes. | öffentlich |
GET | /public-api/v1/auth/check | Validiert Zugangsdaten und gibt Shop, Berechtigungsbereiche und Tarifmöglichkeiten zurück. | beliebige authentifizierte Zugangsdaten |
GET | /public-api/v1/customer-orders | Gibt eine paginierte und filterbare Liste von Kundenbestellungen zurück. | orders:read |
GET | /public-api/v1/customer-orders/:id | Gibt eine einzelne Kundenbestellung mit konfigurierten Produktpositionen zurück. | orders:read |
POST | /public-api/v1/customer-orders/batch | Gibt bis zu 100 Bestellungen anhand ihrer IDs zurück. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Aktualisiert den Bestellstatus. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Aktualisiert die Mengen ausgewählter Bestellpositionen. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Legt eine einheitliche Menge für jede Position einer Bestellung fest. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Löscht eine Kundenbestellung, die dem Shop-Inhaber gehört. | orders:write |
GET | /public-api/v1/products | Gibt Shop-Produkte/-Designs mit Einbettungsverfügbarkeit und Medien-URLs zurück. | products:read |
GET | /public-api/v1/products/:id | Gibt ein Shop-Produkt/-Design zurück. | products:read |
POST | /public-api/v1/embed/session | Stellt ein kurzlebiges JWT für eingebettete Werkzeuge einschließlich des Modellgenerators aus. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Ermittelt den Laufzeitkontext aus einem Einbettungs-JWT. | Bearer-Einbettungstoken |
GET | /public-api/v1/assets | Listet Asset-Katalogeinträge des angeforderten Typs auf. | beliebige authentifizierte Zugangsdaten |
GET | /public-api/v1/assets/:type/:assetId | Gibt ein Asset-Manifest mit herunterladbaren Dateirollen zurück. | beliebige authentifizierte Zugangsdaten |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Lädt eine Asset-Datei anhand ihrer Rolle herunter. | beliebige authentifizierte Zugangsdaten |
GET | /public-api/v1/design-imports | Listet importierbare, bei Alter gehostete Designs auf. | authentifizierte Zugangsdaten, Business-Tarif erforderlich |
GET | /public-api/v1/design-imports/:id | Gibt Designimportdaten und Dateibeschreibungen zurück. | authentifizierte Zugangsdaten, Business-Tarif erforderlich |
GET | /public-api/v1/design-imports/:id/files/:fileId | Lädt eine Datei aus einer Designimportbeschreibung herunter. | authentifizierte Zugangsdaten, Business-Tarif erforderlich |
GET | /public-api/v1/file/public/products/:productId/:size | Gibt eine öffentliche Produktvorschau zurück. Die Größe muss small.png, medium.png oder big.png sein. | öffentlich |
GET | /public-api/v1/file/protected/:key | Gibt eine geschützte Datei anhand ihres Speicherschlüssels zurück. | signierte URL oder files:read |
GET | /public-api/v1/fonts | Gibt alle verfügbaren Schriftarten zurück. | öffentlich |
GET | /public-api/v1/currencies | Gibt alle Währungen zurück. | öffentlich |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Erstellt oder aktualisiert Laufzeitzuordnungen aus WordPress-Produktzuordnungen. | beliebige authentifizierte Zugangsdaten |
PATCH | /public-api/v1/runtime-bindings/:id | Aktualisiert eine Laufzeitzuordnung teilweise. | beliebige authentifizierte Zugangsdaten |
POST | /public-api/v1/runtime-bindings/:id/activate | Aktiviert eine Laufzeitzuordnung. | beliebige authentifizierte Zugangsdaten |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Deaktiviert eine Laufzeitzuordnung. | beliebige authentifizierte Zugangsdaten |
POST | /public-api/v1/wp-connect/exchange | Tauscht einen WordPress-Auto-Connect-Übergabecode gegen API-Zugangsdaten aus. | einmaliger Übergabecode |
GET | /public-api/v1/model-generator/catalog | Listet sichtbare Generatorprodukte, Konfigurationen und Vorlagenrevisionen auf. | embed:session:create |
GET | /public-api/v1/model-generator/models | Listet Modelle mit auf bestimmte Generatorquellen festgelegten Deskriptoren für den Import auf. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Liefert den von Designer verwendeten Katalog der Generatormodelle. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Listet die Generatorprojekte des Eigentümers und global verfügbare Projekte auf. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Liefert die neueste oder ausgewählte Projektrevision, die Vorlage und das Dateimanifest. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Liefert die neueste oder ausgewählte Projektrevision, die Vorlage und das Dateimanifest. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Lädt ein Artefakt nach Prüfung des Zugriffs auf sein Projekt herunter. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Liefert ein zugängliches Vorlagendokument für die ausgewählte Konfigurationsrevision. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Liefert das Importpaket der Vorlage einschließlich der abhängigen Dateien. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Liefert beide Schaufensterpuppen und die Deskriptoren ihrer Ressourcen. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Listet Assets der Textur- oder Hintergrundbibliothek mit importierbaren Dateien auf. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Liefert ein einzelnes Textur- oder Hintergrund-Asset mit seinen importierbaren Dateien. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Lädt eine erlaubte Abhängigkeitsdatei des Generators herunter. | embed:session:create |