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 /dataset/{schema_name}

Извличайте публикувани документи за схема — всички, един, партида или страница — като стриймван JSON масив.

Извличайте публикувани документи за схема — всички, единичен документ, партида по идентификатори или страница — стриймвани като JSON масив. Налично е и на /schemas/{schema_name}. Препратките към изображения се преобразуват в URL адреси, а когато е зададен language, съответният превод се слива с базовото съдържание.

Автентикация: API ключ. Ключ се изисква само когато сървърът зададе require_schema_api_key = true; в противен случай са разрешени анонимни четения.

Параметри на пътя

ПараметърТипЗадължителенБележки
schema_nameниздаСхемата на документа, напр. post.

Параметри на заявката

ПараметърТипЗадължителенБележки
websiteIduuidнеЦелевият уебсайт; при липса се използва заглавката Host / конфигурацията.
iduuidнеИзвлича единичен документ. Има предимство пред ids.
idsнизнеРазделени със запетая UUID стойности (партида, максимум 200). Има предимство пред пагинацията.
languageнизнеОбединява превода за тази локализация върху базовото съдържание.
limitцяло числонеРазмер на страницата, по подразбиране 200, ограничен до 200.
offsetцяло числонеРедове за пропускане (прилага се само при положителен лимит).
api_keyнизнеАлтернатива на заглавката x-api-key.

Когато нито id, нито ids е зададен, документите се връщат подредени по published_at DESC.

Отговор

Стриймван JSON масив. Всеки елемент представлява публикуваното съдържание на документа, разположено на най-горно ниво, плюс вмъкнатите ключове _id, _title и _publishedAt:

[
  {
    "_id": "...",
    "_title": "Първи стъпки",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Първи стъпки",
    "description": "...",
    "content": "..."
  }
]

Полетата на съдържанието имат предимство пред вмъкнатите ключове при конфликт. Препратките към изображения с форма { alt, _asset: { id } } получават резолван url, вмъкнат в _asset.

Пример

curl '{CMS_API_URL}/dataset/post?websiteId=<uuid>&limit=50' \
  -H 'x-api-key: <key>'

Грешки

  • 400 — невалиден websiteId, невалиден id или неправилни ids (празни, повече от 200 или невалиден UUID)
  • 401 — невалиден API ключ (или липсва, когато се изисква)
  • 500 — неуспешна заявка
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›