profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

ניתוב פרמטריסוגי רכיביםSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyכתיבת סקריפטים בבונה התבניותProject Scaffoldingספריית המדיה

ללא ראש

התחלה מהירהSplit Screen JSON Component Builder with LLMComponent Zod Pull

ממשק REST

סקירת REST APIgetחיבור-אתר-ל-API-של-CMSgetGET /routesgetGET /routegetקבלת בלוקיםgetהשגת-בלוקים-עם-מטמון-CELgetGET /blocks/generatedgetקבל רכיביםgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postתרגום פוסטpatchPATCH /translationsgetGET /usagepostפוסט-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}›