profound-logoProfound CMS
⌘K
Admin
Theme
DocsGuidaBlogPhilosophy
DocsGuidaBlogPhilosophy

Hybrid

Instradamento parametricoTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Senza testa

Guida rapidaSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetOttieni percorsogetGET /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)

Flusso di eventi Server-Sent di segnali di modifica dei contenuti per un sito web.

Un flusso longevo di eventi Server-Sent Events (SSE) che notificano le modifiche ai contenuti di un sito web. Ogni evento indica al client di rivalidare immediatamente. Questo sostituisce l'abbonamento tRPC che andava in timeout sulle piattaforme serverless.

Autenticazione: chiave API (necessaria solo quando il server imposta require_schema_api_key = true).

Parametri di query

ParametroTipoObbligatorioNote
websiteIduuidnoSito web di destinazione; utilizza come fallback l'intestazione / configurazione Host.
api_keystringnoAlternativa all'intestazione x-api-key.

Comportamento

  • Content-Type: text/event-stream.
  • Commenti di keep-alive ogni 15 secondi.
  • Emette un evento message per ogni modifica ai contenuti il cui website_id corrisponde al tenant risolto; il payload data: dell'evento è la modifica serializzata in JSON. Le modifiche relative ad altri siti web vengono filtrate.
  • La connessione rimane aperta indefinitamente e nessuna connessione al database viene riservata per l'intera durata del flusso.

Esempio

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

-N disabilita il buffering di curl in modo che gli eventi vengano visualizzati man mano che arrivano.

Errori

  • 400 — websiteId irrisolvibile o non valido
  • 401 — chiave API non valida
  • 500 — errore del pool di connessioni
Continue Reading
Previous‹GET /dataset/{schema_name}NextPATCH /dataset/{schema_name}›