الانتقال إلى المحتوى الرئيسي
يعرض CMS API قواعد البيانات المخصصة التي تقوم بإنشائها في Plato CMS. استخدمه لمواقع الويب والكتالوجات والصفحات المقصودة وبوابات الشركاء والأدوات الداخلية التي تحتاج إلى محتوى منظم من مساحة عمل Plato.

إدخالات القائمة

جلب الإدخالات باستخدام الحقول والمرشحات وترقيم الصفحات ورؤوس الاستجابة المتوقعة.

احصل على دخول واحد

اقرأ إدخال CMS واحد بواسطة المعرف من تكامل موثوق.

إنشاء إدخال

أضف محتوى CMS جديدًا من الواجهة الخلفية أو موقع الويب أو الأداة الداخلية.

تحديث الإدخال

تصحيح أو استبدال محتوى CMS الموجود بأمان.

حذف الإدخال

قم بإزالة سجلات CMS عندما يمتلك التكامل دورة الحياة.

المجالات والعلاقات

فهم القيم وحقول النظام ومعرفات العلاقات والمحتوى المرتبط.

​
نقاط النهاية

GET    /api/public/cms/[modelId]/list
POST   /api/public/cms/[modelId]/list
GET    /api/public/cms/[modelId]/[id]
PATCH  /api/public/cms/[modelId]/[id]
PUT    /api/public/cms/[modelId]/[id]
DELETE /api/public/cms/[modelId]/[id]
modelId يمكن أن يكون معرف قاعدة البيانات CMS أو معرف قاعدة البيانات. استخدم معرفات قاعدة البيانات القابلة للقراءة مثل products أو locations أو team_members عندما يكون ذلك ممكنًا. إنها تجعل صيانة عناوين URL API أسهل.

​
المصادقة

تقبل نقاط النهاية CMS: 
Authorization: Bearer plato_your_api_key
أو: 
x-api-key: plato_your_api_key
يمكن لعمليات التكامل الأقدم أن تستخدم: 
?apiKey=plato_your_api_key
يجب أن يتضمن الدور الرئيسي API الوصول إلى CMS.

​
مجالات النظام

يمكن أن يتضمن كل إدخال ما يلي:
مجالمعنى
idمعرف الإدخال.
createdAtتاريخ إنشاء الإدخال.
updatedAtتاريخ التحديث الأخير، عندما يكون متاحا.
يتم تحديد هذه الحقول بشكل افتراضي عند عدم إرسال أي استعلام fields.

​
رؤوس الاستجابة

تتضمن استجابات القائمة والإدخال رؤوس البيانات التعريفية CMS.
رأسمعنى
x-cms-model-idمعرف قاعدة البيانات الداخلية التي تطابق الطلب.
x-cms-model-identifierمعرف قاعدة البيانات القابلة للقراءة، عند تكوينها.
x-cms-totalإجمالي عدد الإدخالات لطلبات القائمة.
x-cms-limitالحد الذي يستخدمه طلب القائمة.
x-cms-offsetالإزاحة المستخدمة في طلب القائمة.
x-cms-has-more1 عند توفر المزيد من الصفوف.

​
التدفق النموذجي

  1. قم بإنشاء أو فتح قاعدة بيانات CMS في Plato.
  2. قم بتأكيد معرف قاعدة البيانات ومفاتيح الحقول.
  3. قم بإنشاء مفتاح API مع إمكانية الوصول إلى CMS.
  4. قم بإدراج الإدخالات مع الحقول التي يحتاجها تطبيقك.
  5. استخدم الإنشاء والتحديث والحذف فقط من رمز الخادم الموثوق به.
لإعداد المخطط، راجع أدوات المطور CMS.