एंडपॉइंट का अवलोकन
नीचे की तालिका backend-public-api/app.js में दर्ज सार्वजनिक रूट दिखाती है। पाथ में बाहरी एकीकरण द्वारा इस्तेमाल किया जाने वाला सार्वजनिक प्रॉक्सी प्रीफ़िक्स शामिल है।
| विधि | एंडपॉइंट | विवरण | ऐक्सेस |
|---|---|---|---|
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 | ID से अधिकतम 100 ऑर्डर लौटाता है। | 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 से रनटाइम संदर्भ प्राप्त करता है। | Bearer एम्बेड टोकन |
GET | /public-api/v1/assets | माँगे गए प्रकार के एसेट कैटलॉग आइटम की सूची देता है। | कोई भी प्रमाणित क्रेडेंशियल |
GET | /public-api/v1/assets/:type/:assetId | डाउनलोड की जा सकने वाली फ़ाइल भूमिकाओं वाला एसेट मैनिफ़ेस्ट लौटाता है। | कोई भी प्रमाणित क्रेडेंशियल |
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 | सबसे नया या चुना गया प्रोजेक्ट संशोधन, टेम्पलेट और फ़ाइल मैनिफ़ेस्ट लौटाता है। | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | सबसे नया या चुना गया प्रोजेक्ट संशोधन, टेम्पलेट और फ़ाइल मैनिफ़ेस्ट लौटाता है। | 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 |