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 proxySzkriptelés a sablonkészítőbenProject ScaffoldingMédiatár

Fej nélküli

Quick startJSON és Claude kódComponent Zod Pull

REST API

REST API áttekintésgetConnect your websitegetGET /routesgetÚtvonal feloldásagetBlokkok lekérésegetGET /blocks/with-cel-cachegetGenerált blokkok lekérésegetKomponensek lekérésegetGET /components/{name}getAdatkészlet-séma nevének lekérésegetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postUtólagos fordításpatchFordítások javításagetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /content-changes (SSE)

Server-Sent Events adatfolyam tartalomváltozási jelzésekhez egy webhely számára.

Egy hosszú élettartamú Server-Sent Events (SSE) adatfolyam egy webhely tartalomváltozási eseményeihez. Minden esemény értesíti a klienst, hogy azonnal hajtsa végre az újraellenőrzést. Ez kiváltja azt a tRPC-előfizetést, amely a szerver nélküli platformokon időtúllépésbe futott.

Hitelesítés: API-kulcs (csak akkor szükséges, ha a szerver a require_schema_api_key = true értéket állítja be).

Lekérdezési paraméterek

ParaméterTípusKötelezőMegjegyzések
websiteIduuidnemCél webhely; visszatér a Host fejléc / konfiguráció értékéhez.
api_keystringnemAlternatívája az x-api-key fejlécnek.

Viselkedés

  • Content-Type: text/event-stream.
  • 15 másodpercenként keep-alive megjegyzések.
  • Egy üzeneteseményt bocsát ki minden olyan tartalomváltozáskor, amelynek website_id mezője megegyezik a feloldott bérlővel; az esemény data: hasznos terhe a változás JSON-ként sorosítva. A más webhelyekhez tartozó változások kiszűrésre kerülnek.
  • A kapcsolat határozatlan ideig nyitva marad, és a folyam élettartama alatt nem rögzítünk adatbázis-kapcsolatot.

Példa

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

-N letiltja a curl pufferelését, így az események azonnal megjelennek, amint megérkeznek.

Hibák

  • 400 — feloldhatatlan vagy érvénytelen websiteId
  • 401 — érvénytelen API-kulcs
  • 500 — kapcsolatkészlet-hiba
Continue Reading
Previous‹Adatkészlet-séma nevének lekéréseNextPATCH /dataset/{schema_name}›