profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametriskā maršrutēšanaKomponentu veidiSetup server sent events (SSE) content refetchIestatīt administratora paneļa starpniekserveriSkriptēšana veidņu veidotājāProject ScaffoldingMultivides bibliotēka

Headless

Ātrā uzsākšanaSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetSaņemt maršrutusgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPēctulkošanapatchTulkojumu labojumigetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /content-changes (SSE)

Serveru sūtītu notikumu straume, kas nodrošina satura izmaiņu signālus tīmekļa vietnei.

Ilgstoša Server-Sent Events (SSE) straume ar satura izmaiņu notikumiem tīmekļa vietnei. Katrs notikums norāda klientam nekavējoties veikt atkārtotu validāciju. Tas aizstāj tRPC abonementu, kas bezserveru platformās beidzās ar noildzi.

Autentifikācija: API atslēga (nepieciešama tikai tad, ja serveris iestata require_schema_api_key = true).

Vaicājuma parametri

ParametrsTipsObligātsPiezīmes
websiteIduuidnēMērķa tīmekļa vietne; pēc noklusējuma tiek izmantota Host galvene / konfigurācija.
api_keystringnēAlternatīva x-api-key galvenei.

Uzvedība

  • Content-Type: text/event-stream.
  • Uzturošie komentāri ik pēc 15 sekundēm.
  • Izraida vienu ziņojuma notikumu par katru satura izmaiņu, kuras website_id atbilst noteiktajam nomniekam; notikuma data: lietderīgā slodze ir izmaiņas, kas serializētas kā JSON. Izmaiņas citām tīmekļa vietnēm tiek atfiltrētas.
  • Savienojums tiek turēts atvērts beztermiņa, un straumes darbības laikā netiek piesaistīts neviens datubāzes savienojums.

Piemērs

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

-N atspējo curl buferizāciju, lai notikumi tiktu parādīti, tiklīdz tie pienāk.

Kļūdas

  • 400 — neatrisināms vai nederīgs websiteId
  • 401 — nederīga API atslēga
  • 500 — savienojumu kopnes kļūme
Continue Reading
Previous‹GET /dataset/{schema_name}NextPATCH /dataset/{schema_name}›