profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametrinis maršrutizavimasKomponentų tipaiSetup server sent events (SSE) content refetchAdministratoriaus skydelio tarpinio serverio nustatymasSkriptų kūrimas šablonų kūrimo priemonėjeProject ScaffoldingMedia Library

Be sąsajos

Greitasis startasSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API apžvalgagetPrijunkite svetainę prie CMS APIgetGET /routesgetGauti maršrutągetGET /blocksgetGET /blocks/with-cel-cachegetGET /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 srautas, siunčiantis svetainės turinio pokyčių signalus.

Ilgaamžis Server-Sent Events (SSE) srautas, perduodantis svetainės turinio pakeitimų įvykius. Kiekvienas įvykis nurodo klientui nedelsiant pakartotinai patvirtinti. Tai pakeičia tRPC prenumeratą, kuri serverless platformose baigdavosi laiku.

Autentifikacija: API raktas (reikalingas tik tuomet, kai serveris nustato require_schema_api_key = true).

Užklausos parametrai

ParametrasTipasPrivalomasPastabos
websiteIduuidneTikslinei svetainei; jei nenurodyta, naudojama Host antraštė / konfigūracija.
api_keystringneAlternatyva x-api-key antraštei.

Veikimas

  • Content-Type: text/event-stream.
  • Keep-alive komentarai kas 15 sekundžių.
  • Išsiunčia vieną pranešimo įvykį kiekvienam turinio pakeitimui, kurio website_id sutampa su nustatytu nuomininku; įvykio data: naudingasis krūvis yra pakeitimas, suserializuotas į JSON. Kitų svetainių pakeitimai perfiltruojami.
  • Ryšys laikomas atviras neribotą laiką, o duomenų bazės ryšys srauto trukmei nepririšamas.

Pavyzdys

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

-N išjungia curl buferiavimą, kad įvykiai būtų rodomi vos tik juos gavus.

Klaidos

  • 400 — neišsprendžiamas arba neteisingas websiteId
  • 401 — neteisingas API raktas
  • 500 — ryšių telkinio gedimas
Continue Reading
Previous‹GET /dataset/{schema_name}NextPATCH /dataset/{schema_name}›