profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialБлогPhilosophy
DocsTutorialБлогPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyНаписание скриптов в конструкторе шаблоновProject ScaffoldingМедиатека

Без интерфейса

Быстрый стартSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Обзор REST APIgetConnect your websitegetПолучить маршрутыgetGET /routegetПолучение блоковgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetПолучить компонентыgetGET /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 с сигналами об изменениях контента для веб-сайта.

Долгоживущий поток событий изменения контента для веб-сайта, реализованный при помощи Server-Sent Events (SSE). Каждое событие сообщает клиенту, что нужно немедленно повторно выполнить проверку. Это заменяет подписку tRPC, которая истекала по времени на бессерверных платформах.

Авторизация: ключ API (требуется только в том случае, если сервер устанавливает require_schema_api_key = true).

Параметры запроса

ПараметрТипОбязательноПримечания
websiteIduuidнетЦелевой веб-сайт; при отсутствии используется заголовок Host или конфигурация.
api_keystringнетАльтернатива заголовку x-api-key.

Поведение

  • Content-Type: text/event-stream.
  • Комментарии keep-alive каждые 15 секунд.
  • Генерирует одно событие сообщения для каждого изменения контента, у которого website_id совпадает с определённым арендатором; полезная нагрузка события data: — изменение, сериализованное в JSON. Изменения для других веб-сайтов отфильтровываются.
  • Соединение поддерживается открытым неопределённо долго, и ни одно подключение к базе данных не закрепляется на время существования потока.

Пример

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

-N отключает буферизацию curl, поэтому события отображаются по мере поступления.

Ошибки

  • 400 — неразрешимый или недопустимый websiteId
  • 401 — недействительный ключ API
  • 500 — сбой пула соединений
Continue Reading
Previous‹GET /dataset/{schema_name}NextPATCH /dataset/{schema_name}›