إضافة المقالة
محتويات الصفحة
تشرح هذه المقالة كيفية إدارة مقالات قاعدة المعرفة عبر API زيتون، بما في ذلك عرض المقالات وتصفية نتائجها وإنشاء مقالات جديدة تعديلها أو حذفها واستعادتها، باستخدام أمثلة عملية واضحة للمطورين.
عرض مقالة
لعرض المقالة رقم 1005 في مركز المساعدة نرسل الطلب التالي:
curl 'https://example.com/api/agent/v1/articles/1005' \
-H 'Authorization: Bearer $TOKEN' \
تصفية المقالات
لعرض مقالات قاعدة المعرفة التي أنشأها الوكيل رقم 1008 نكتب التالي:
curl "https://example.com/api/agent/v1/articles?agent_ids[]=1008" \
-H "Authorization: Bearer $TOKEN" \
--globoff
لعرض المقالات التي تتضمن عناوينها كلمة معينة ولتكن "كيف" مثلًا نكتب الطلب التالي:
curl "https://example.com/api/agent/v1/articles?query=كيف" \
-H "Authorization: Bearer $TOKEN" \
إضافة مقالة
لإنشاء مقال جديد في قاعدة المعرفة الخاصة نكتب الطلب على النحو التالي:
curl -X POST "https://example.com/api/agent/v1/articles" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "من أين أحصل على تطبيق الشركة؟",
"meta_keywords": "app,تطبيق",
"meta_description": "طريقة تحميل وتثبيت التطبيق",
"slug": "how-to-download-app",
"sort": 0,
"category_ids": [1007],
"featured": true,
"tags": ["تعليمي", "شائع"],
"knowledgebase_id": 1004,
"locale": "ar",
"status": "published",
"blocks": [
{
"content": "<p class=\"editor__paragraph\" dir=\"rtl\" style=\"\"><span style=\"white-space: pre-wrap;\">اتبع الخطوات التالية:</span></p><p class=\"editor__paragraph\" dir=\"rtl\" style=\"\"><span style=\"white-space: pre-wrap;\">الخطوة 1:</span></p><p class=\"editor__paragraph\" dir=\"rtl\" style=\"\"><span style=\"white-space: pre-wrap;\">الخطوة 2:</span></p><p class=\"editor__paragraph\" dir=\"rtl\" style=\"\"><span style=\"white-space: pre-wrap;\">الخطوة 3:</span></p>",
"sort": 0
},
{
"form_id": "1012",
"sort": 1
}
]
}'
تعديل مقالة
لنجرب تعديل المقال رقم 1005 بتعديل ترتيب المقال ليصبح 2 وتعديل وسوم المقال بإزالة الوسم شائع منها وحذف نموذج التواصل من محتويات المقال، والإبقاء على المحتوى النصي فقط نكتب الطلب كما يلي:
curl -X PUT "https://example.com/api/agent/v1/articles/1005" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "من أين أحصل على تطبيق الشركة؟",
"slug": "how-to-download-app",
"sort": 2,
"category_ids": [1007],
"tags": ["تعليمي"],
"status": "published",
"blocks": [
{
"id": 773,
"content": "<p class=\"editor__paragraph\" dir=\"rtl\" style=\"\"><span style=\"white-space: pre-wrap;\">اتبع الخطوات التالية:</span></p><p class=\"editor__paragraph\" dir=\"rtl\" style=\"\"><span style=\"white-space: pre-wrap;\">الخطوة 1:</span></p><p class=\"editor__paragraph\" dir=\"rtl\" style=\"\"><span style=\"white-space: pre-wrap;\">الخطوة 2:</span></p><p class=\"editor__paragraph\" dir=\"rtl\" style=\"\"><span style=\"white-space: pre-wrap;\">الخطوة 3:</span></p>",
"sort": 0
}
]
}'
حذف مقالة
لحذف المقال رقم 1005 نكتب الطلب التالي:
curl "https://example.com/api/agent/v1/articles/1005" \
-X DELETE \
-H "Authorization: Bearer $TOKEN"
لاستعادة نفس المقالة نُرسل الطلب التالي:
curl "https://example.com/api/agent/v1/articles/1005/restore" \
-X POST \
-H "Authorization: Bearer $TOKEN"