Επισκόπηση endpoints
Ο πίνακας παρακάτω αντιστοιχεί στις δημόσιες διαδρομές του backend-public-api/app.js. Οι διαδρομές εμφανίζονται με το πρόθεμα δημόσιου proxy που χρησιμοποιούν οι εξωτερικές ενσωματώσεις.
| Μέθοδος | Endpoint | Περιγραφή | Πρόσβαση |
|---|---|---|---|
GET | /public-api/healthz | Έλεγχος υγείας υπηρεσίας. | δημόσιο |
GET | /public-api/v1/auth/check | Επικυρώνει διαπιστευτήρια και επιστρέφει κατάστημα, δικαιώματα και δυνατότητες προγράμματος. | οποιαδήποτε έγκυρα διαπιστευτήρια |
GET | /public-api/v1/customer-orders | Επιστρέφει λίστα παραγγελιών πελατών με σελιδοποίηση και φίλτρα. | orders:read |
GET | /public-api/v1/customer-orders/:id | Επιστρέφει μία παραγγελία πελάτη με διαμορφωμένα στοιχεία προϊόντων. | orders:read |
POST | /public-api/v1/customer-orders/batch | Επιστρέφει έως 100 παραγγελίες βάσει ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Ενημερώνει την κατάσταση παραγγελίας. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Ενημερώνει τις ποσότητες επιλεγμένων στοιχείων παραγγελίας. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Ορίζει μία ποσότητα για κάθε στοιχείο της παραγγελίας. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Διαγράφει παραγγελία πελάτη που ανήκει στον ιδιοκτήτη του καταστήματος. | orders:write |
GET | /public-api/v1/products | Επιστρέφει προϊόντα/σχέδια καταστήματος με διαθεσιμότητα ενσωμάτωσης και URL πολυμέσων. | products:read |
GET | /public-api/v1/products/:id | Επιστρέφει ένα προϊόν/σχέδιο καταστήματος. | products:read |
POST | /public-api/v1/embed/session | Εκδίδει ένα JWT μικρής διάρκειας για ενσωματωμένα εργαλεία, συμπεριλαμβανομένης της γεννήτριας μοντέλων. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Επιλύει το πλαίσιο εκτέλεσης από JWT ενσωμάτωσης. | token ενσωμάτωσης Bearer |
GET | /public-api/v1/assets | Παραθέτει πόρους καταλόγου του ζητούμενου τύπου. | οποιαδήποτε έγκυρα διαπιστευτήρια |
GET | /public-api/v1/assets/:type/:assetId | Επιστρέφει manifest πόρου με ρόλους αρχείων διαθέσιμων για λήψη. | οποιαδήποτε έγκυρα διαπιστευτήρια |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Κατεβάζει αρχείο πόρου βάσει ρόλου. | οποιαδήποτε έγκυρα διαπιστευτήρια |
GET | /public-api/v1/design-imports | Παραθέτει εισαγώγιμα σχέδια που φιλοξενούνται στο Alter. | έγκυρα διαπιστευτήρια, απαιτείται πρόγραμμα Business |
GET | /public-api/v1/design-imports/:id | Επιστρέφει δεδομένα εισαγωγής σχεδίου και περιγραφές αρχείων. | έγκυρα διαπιστευτήρια, απαιτείται πρόγραμμα Business |
GET | /public-api/v1/design-imports/:id/files/:fileId | Κατεβάζει αρχείο από περιγραφή εισαγωγής σχεδίου. | έγκυρα διαπιστευτήρια, απαιτείται πρόγραμμα Business |
GET | /public-api/v1/file/public/products/:productId/:size | Επιστρέφει δημόσια προεπισκόπηση προϊόντος. Το μέγεθος πρέπει να είναι small.png, medium.png ή big.png. | δημόσιο |
GET | /public-api/v1/file/protected/:key | Επιστρέφει προστατευμένο αρχείο βάσει κλειδιού αποθήκευσης. | υπογεγραμμένο URL ή files:read |
GET | /public-api/v1/fonts | Επιστρέφει όλες τις διαθέσιμες γραμματοσειρές. | δημόσιο |
GET | /public-api/v1/currencies | Επιστρέφει όλα τα νομίσματα. | δημόσιο |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Δημιουργεί ή ενημερώνει συνδέσεις εκτέλεσης από αντιστοιχίσεις προϊόντων WordPress. | οποιαδήποτε έγκυρα διαπιστευτήρια |
PATCH | /public-api/v1/runtime-bindings/:id | Ενημερώνει μερικώς μια σύνδεση εκτέλεσης. | οποιαδήποτε έγκυρα διαπιστευτήρια |
POST | /public-api/v1/runtime-bindings/:id/activate | Ενεργοποιεί μια σύνδεση εκτέλεσης. | οποιαδήποτε έγκυρα διαπιστευτήρια |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Απενεργοποιεί μια σύνδεση εκτέλεσης. | οποιαδήποτε έγκυρα διαπιστευτήρια |
POST | /public-api/v1/wp-connect/exchange | Ανταλλάσσει κωδικό αυτόματης σύνδεσης WordPress με διαπιστευτήρια API. | κωδικός μεταβίβασης μίας χρήσης |
GET | /public-api/v1/model-generator/catalog | Εμφανίζει τα ορατά προϊόντα της γεννήτριας, τις διαμορφώσεις και τις αναθεωρήσεις προτύπων. | embed:session:create |
GET | /public-api/v1/model-generator/models | Εμφανίζει μοντέλα με περιγραφείς που ορίζουν συγκεκριμένες αναθεωρήσεις προέλευσης της γεννήτριας για εισαγωγή. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Επιστρέφει τον κατάλογο μοντέλων της γεννήτριας που χρησιμοποιεί το Designer. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Εμφανίζει τα έργα γεννήτριας του κατόχου και όσα είναι διαθέσιμα καθολικά. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Επιστρέφει την πιο πρόσφατη ή την επιλεγμένη αναθεώρηση έργου, το πρότυπο και το manifest αρχείων. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Επιστρέφει την πιο πρόσφατη ή την επιλεγμένη αναθεώρηση έργου, το πρότυπο και το manifest αρχείων. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Κατεβάζει ένα τεχνούργημα αφού ελέγξει την πρόσβαση στο έργο του. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Επιστρέφει ένα προσβάσιμο έγγραφο προτύπου για την επιλεγμένη αναθεώρηση διαμόρφωσης. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Επιστρέφει το πακέτο εισαγωγής προτύπου μαζί με τα αρχεία εξαρτήσεων. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Επιστρέφει και τις δύο κούκλες και τους περιγραφείς των πόρων τους. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Εμφανίζει πόρους της βιβλιοθήκης υφών ή φόντων με αρχεία που μπορούν να εισαχθούν. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Επιστρέφει έναν πόρο υφής ή φόντου μαζί με τα αρχεία που μπορούν να εισαχθούν. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Κατεβάζει ένα επιτρεπόμενο αρχείο εξάρτησης της γεννήτριας. | embed:session:create |