profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametrično usmerjanjeTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyPisanje skript v graditelju predlogProject ScaffoldingMedijska knjižnica

Brez glave

Hitri začetekSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Pregled REST API-jagetPovezava spletnega mesta z API-jemgetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPrevajanje objavepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /content-changes (SSE)

Tok dogodkov, poslanih s strežnika, s signali sprememb vsebine za spletno mesto.

Dolgotrajni tok Server-Sent Events (SSE) z dogodki sprememb vsebine za spletno mesto. Vsak dogodek odjemalcu sporoči, naj takoj ponovno validira. To nadomešča naročnino tRPC, ki je na brezstrežniških platformah potekla.

Avtentikacija: Ključ API (zahtevan le, ko strežnik nastavi require_schema_api_key = true).

Parametri poizvedbe

ParameterVrstaZahtevanoOpombe
websiteIduuidneCiljno spletno mesto; se privzeto opre na glavo Host oziroma konfiguracijo.
api_keystringneAlternativa glavi x-api-key.

Obnašanje

  • Content-Type: text/event-stream.
  • Komentarji za ohranjanje povezave (keep-alive) vsakih 15 sekund.
  • Odda en dogodek sporočila za vsako spremembo vsebine, katere website_id se ujema z razrešenim najemnikom; nosilec data: dogodka je sprememba, serializirana kot JSON. Spremembe za druga spletna mesta so filtrirane.
  • Povezava ostane odprta neomejeno dolgo, pri čemer nobena povezava z zbirko podatkov ni pripeta za življenjsko dobo toka.

Primer

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

-N onemogoči medpomnjenje v curl, zato se dogodki pojavijo takoj, ko prispejo.

Napake

  • 400 — websiteId, ki ga ni mogoče razrešiti ali je neveljaven
  • 401 — neveljaven ključ API
  • 500 — okvara zbirke povezav
Continue Reading
Previous‹GET /dataset/{schema_name}NextPATCH /dataset/{schema_name}›