الانتقال إلى المحتوى الرئيسي
استخدم طلبات القائمة لعرض الصفحات أو مزامنة المحتوى أو جلب صفحة صغيرة من السجلات.
GET /api/public/cms/[modelId]/list

مثال

curl "https://api.plato.ae/api/public/cms/products/list?limit=20&offset=0" \
  -H "Authorization: Bearer $PLATO_API_KEY"

معلمات الاستعلام

المعلمةيكتبتقصيرملحوظات
limitرقم20الحد الأدنى 1 والحد الأقصى 100.
offsetرقم0عدد الإدخالات المطلوب تخطيها.
fieldsخيطحقول النظام والحقول المرئيةحدد مجالات محددة.
includeHiddenمنطقيةfalseقم بتضمين حقول CMS المخفية عندما يتمكن المفتاح من الوصول إليها.
maxDepthرقم3عمق توسيع العلاقة. الحد الأقصى 6.

حدد الحقول

استخدم fields لإبقاء الردود صغيرة:
curl "https://api.plato.ae/api/public/cms/products/list?fields=id,name,price,category(id,name)" \
  -H "Authorization: Bearer $PLATO_API_KEY"
تستخدم حقول العلاقات المتداخلة الأقواس:
category(id,name)

إجابة

جسم الاستجابة عبارة عن مصفوفة.
[
  {
    "id": "entry_123",
    "name": {
      "en": "Classic Burger",
      "ar": "Classic Burger"
    },
    "price": 38,
    "category": {
      "id": "entry_category_1",
      "name": {
        "en": "Burgers"
      }
    }
  }
]
يتم إرجاع البيانات التعريفية للصفحات في الرؤوس:
x-cms-total: 86
x-cms-limit: 20
x-cms-offset: 0
x-cms-has-more: 1

الصفحة التالية

قم بزيادة offset بعدد الصفوف المحملة بالفعل:
curl "https://api.plato.ae/api/public/cms/products/list?limit=20&offset=20" \
  -H "Authorization: Bearer $PLATO_API_KEY"

ملحوظات

  • يتم تحديد نطاق القوائم في مساحة العمل المرفقة بالمفتاح API.
  • تُرجع أسماء الحقول غير المعروفة 400.
  • يتوقف توسيع العلاقة عند maxDepth.
  • بالنسبة للصفحات العامة، حدد فقط الحقول المطلوبة في تلك الصفحة.