profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

Quick startJSON และ Claude Codeดึงคำอธิบาย Zod ของคอมโพเนนต์

REST API

REST API Overviewgetเชื่อมต่อเว็บไซต์กับ CMS APIgetGET /routesgetGET /routegetGET /blocksgetรับบล็อกพร้อมแคช CELgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /content-changes (SSE)

สตรีม Server-Sent Events ของสัญญาณการเปลี่ยนแปลงเนื้อหาสำหรับเว็บไซต์

สตรีม Server-Sent Events (SSE) ที่มีอายุการเชื่อมต่อยาวสำหรับเหตุการณ์การเปลี่ยนแปลงเนื้อหาของเว็บไซต์ แต่ละเหตุการณ์จะสั่งให้ไคลเอนต์ทำการตรวจสอบสภาพอีกครั้งทันที สิ่งนี้ใช้แทนการสมัครรับข้อมูล tRPC ที่หมดเวลาในแพลตฟอร์มแบบไร้เซิร์ฟเวอร์

การรับรองความถูกต้อง: คีย์ API (จำเป็นเฉพาะเมื่อเซิร์ฟเวอร์ตั้งค่า require_schema_api_key = true)

พารามิเตอร์คิวรี

พารามิเตอร์ชนิดจำเป็นหมายเหตุ
websiteIduuidไม่เว็บไซต์เป้าหมาย; จะใช้ค่า Host เฮดเดอร์ / การตั้งค่า หากไม่ระบุ
api_keystringไม่ทางเลือกแทนเฮดเดอร์ x-api-key

พฤติกรรมการทำงาน

  • Content-Type: text/event-stream.
  • ส่งความคิดเห็น keep-alive ทุก 15 วินาที
  • ส่งเหตุการณ์ข้อความหนึ่งครั้งต่อการเปลี่ยนแปลงเนื้อหาที่มี website_id ตรงกับผู้เช่าที่ถูกแก้ไขแล้ว; ข้อมูลเพย์โหลด data: ของเหตุการณ์คือการเปลี่ยนแปลงที่ถูกทำให้เป็น JSON การเปลี่ยนแปลงของเว็บไซต์อื่นจะถูกกรองออกไป
  • การเชื่อมต่อจะถูกเปิดค้างไว้ไม่มีกำหนด และไม่มีการยึดการเชื่อมต่อฐานข้อมูลไว้ตลอดอายุของสตรีม

ตัวอย่าง

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

-N ปิดการบัฟเฟอร์ของ curl เพื่อให้อีเวนต์ปรากฏทันทีที่มาถึง

ข้อผิดพลาด

  • 400 — ไม่สามารถระบุหรือ websiteId ไม่ถูกต้อง
  • 401 — คีย์ API ไม่ถูกต้อง
  • 500 — ความล้มเหลวของพูลการเชื่อมต่อ
Continue Reading
Previous‹GET /dataset/{schema_name}NextPATCH /dataset/{schema_name}›