profound-logoProfound CMS
⌘K
Admin
Theme
DokumentaceTutorialBlogPhilosophy
DokumentaceTutorialBlogPhilosophy

Hybrid

Parametrické směrováníTypes of ComponentsSetup server sent events (SSE) content refetchNastavení proxy administračního paneluCEL Scripting in Template BuilderProject ScaffoldingKnihovna médií

Headless

Rychlý startJson a claude kódComponent Zod Pull

rozhraní REST API

REST API OverviewgetPřipojení webu k API CMSgetGET /routesgetGET /routegetGET /blocksgetzískat bloky s mezipamětí CELgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPřeklad po publikacipatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /content-changes (SSE)

Proud Server-Sent Events se signály změn obsahu pro web.

Dlouhotrvající proud událostí Server-Sent Events (SSE) změn obsahu pro web. Každá událost sdělí klientovi, aby právě teď znovu ověřil. Tím se nahrazuje odběr tRPC, který na serverless platformách vypršel.

Autorizace: Klíč API (vyžadováno pouze tehdy, když server nastaví require_schema_api_key = true).

Parametry dotazu

ParametrTypPovinnéPoznámky
websiteIduuidneCílový web; v případě potřeby se použije hlavička Host / konfigurace.
api_keystringneAlternativa k hlavičce x-api-key.

Chování

  • Content-Type: text/event-stream.
  • Komentáře keep-alive každých 15 sekund.
  • Vysílá jednu událost zprávy na každou změnu obsahu, jejíž website_id odpovídá určenému tenantovi; užitečné zatížení data: události je změna serializovaná jako JSON. Změny pro jiné weby jsou odfiltrovány.
  • Připojení zůstává otevřené na neurčito a po dobu trvání proudu není připnuto žádné databázové připojení.

Příklad

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

-N vypíná bufferování nástroje curl, takže události dorážejí hned, jakmile přijdou.

Chyby

  • 400 — neřešitelný nebo neplatný websiteId
  • 401 — neplatný klíč API
  • 500 — selhání fondu připojení
Continue Reading
Previous‹GET /dataset/{schema_name}NextPATCH /dataset/{schema_name}›