profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsТипове компонентиSetup 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 APIgetСвързване на уебсайт към CMS APIgetGET /routesgetGET /routegetGET /blocksgetВземане на блокове с CEL кешgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postПревод на публикацияpatchPATCH /translationsgetПолучаване на използванетоpostPOST /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.
  • Коментари за поддържане на връзката на всеки 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}›