نظرة عامة على نقاط النهاية
يعكس الجدول أدناه المسارات العامة المسجّلة في 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 | إعادة ما يصل إلى 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 |