> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plato.ae/llms.txt
> Use this file to discover all available pages before exploring further.

# نظرة عامة على CMS API

> قراءة وكتابة إدخالات CMS من مواقع الويب والتطبيقات وعمليات التكامل الموثوقة.

يعرض CMS API قواعد البيانات المخصصة التي تقوم بإنشائها في Plato CMS.

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

<CardGroup cols={3}>
  <Card title="إدخالات القائمة" icon="rows-3" href="/ar/api-reference/cms/list-entries">
    جلب الإدخالات باستخدام الحقول والمرشحات وترقيم الصفحات ورؤوس الاستجابة المتوقعة.
  </Card>

  <Card title="احصل على دخول واحد" icon="database" href="/ar/api-reference/cms/get-entry">
    اقرأ إدخال CMS واحد بواسطة المعرف من تكامل موثوق.
  </Card>

  <Card title="إنشاء إدخال" icon="plus" href="/ar/api-reference/cms/create-entry">
    أضف محتوى CMS جديدًا من الواجهة الخلفية أو موقع الويب أو الأداة الداخلية.
  </Card>

  <Card title="تحديث الإدخال" icon="settings" href="/ar/api-reference/cms/update-entry">
    تصحيح أو استبدال محتوى CMS الموجود بأمان.
  </Card>

  <Card title="حذف الإدخال" icon="archive" href="/ar/api-reference/cms/delete-entry">
    قم بإزالة سجلات CMS عندما يمتلك التكامل دورة الحياة.
  </Card>

  <Card title="المجالات والعلاقات" icon="link" href="/ar/api-reference/cms/fields-and-values">
    فهم القيم وحقول النظام ومعرفات العلاقات والمحتوى المرتبط.
  </Card>
</CardGroup>

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

```text theme={null}
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:

```http theme={null}
Authorization: Bearer plato_your_api_key
```

أو:

```http theme={null}
x-api-key: plato_your_api_key
```

يمكن لعمليات التكامل الأقدم أن تستخدم:

```text theme={null}
?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-more`         | `1` عند توفر المزيد من الصفوف.                    |

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

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

لإعداد المخطط، راجع [أدوات المطور CMS](/ar/cms/developer/tools).
