profound-logoProfound CMS
⌘K
Admin
Theme
Docsبرنامج تعليميBlogPhilosophy
Docsبرنامج تعليميBlogPhilosophy

Hybrid

التوجيه البارامتريTypes of Componentsإس إس إيInstall Profound CMS as a proxyالبرمجة النصية في منشئ القوالبProject Scaffoldingمكتبة الوسائط

بلا رأس

البدء السريعJSON و Claude CodeComponent Zod Pull

واجهة برمجة تطبيقات REST

نظرة عامة على واجهة RESTgetربط موقع الويب بواجهة برمجة التطبيقاتgetالحصول على المساراتgetالحصول على مسارgetالحصول على الكتلgetجلب الكتل مع ذاكرة CEL المؤقتةgetGET /blocks/generatedgetالحصول على المكوناتgetGET /components/{name}getالحصول على اسم مخطط مجموعة البياناتgetالحصول على تغييرات المحتوى (SSE)patchPATCH /dataset/{schema_name}postترجمة المنشورpatchPATCH /translationsgetالحصول على الاستخدامpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

الحصول على تغييرات المحتوى (SSE)

تدفق أحداث مُرسلة من الخادم لإشارات تغييرات المحتوى لموقع ويب.

تدفق طويل الأمد من أحداث مُرسلة من الخادم (SSE) لتغييرات المحتوى الخاصة بموقع ويب. يُخبر كل حدث العميل بضرورة إعادة التحقق فورًا. يحل هذا محل اشتراك tRPC الذي كان ينتهي بمهلة على المنصات عديمة الخوادم.

المصادقة: مفتاح واجهة برمجة التطبيقات (يُطلب فقط عندما يضبط الخادم require_schema_api_key = true).

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

المعاملالنوعإلزاميملاحظات
websiteIduuidلاموقع الويب المستهدف؛ يستخدم ترويسة Host أو الإعدادات الافتراضية عند عدم التحديد.
api_keystringلابديل لترويسة x-api-key.

السلوك

  • نوع المحتوى: text/event-stream.
  • تعليقات للحفاظ على الاتصال كل 15 ثانية.
  • يبث حدثًا واحدًا من نوع رسالة لكل تغيير محتوى يكون فيه website_id مطابقًا للمستأجر الذي تم تحديده؛ يحتوي حمْل data: للحدث على التغيير مسلسلاً بصيغة JSON. يتم ترشيح التغييرات الخاصة بالمواقع الأخرى.
  • يُبقى الاتصال مفتوحًا إلى أجل غير مسمى، ولا يتم تثبيت أي اتصال قاعدة بيانات طوال مدة التدفق.

مثال

curl -N '{CMS_API_URL}/content-changes?websiteId=<uuid>' \
  -H 'x-api-key: <key>'

-N يعطّل التخزين المؤقت لـ curl بحيث تظهر الأحداث فور وصولها.

الأخطاء

  • 400 — websiteId غير قابل للحل أو غير صالح
  • 401 — مفتاح واجهة برمجة تطبيقات غير صالح
  • 500 — فشل في مجموعة الاتصالات
Continue Reading
Previous‹الحصول على اسم مخطط مجموعة البياناتNextPATCH /dataset/{schema_name}›