profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametrično usmerjanjeTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyPisanje skript v graditelju predlogProject ScaffoldingMedijska knjižnica

Brez glave

Hitri začetekSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Pregled REST API-jagetPovezava spletnega mesta z API-jemgetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPrevajanje objavepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /dataset/{schema_name}

Pridobite objavljene dokumente za shemo — vse, enega, paket ali stran — kot pretočno polje JSON.

Pridobite objavljene dokumente za shemo — vse, posamezen dokument, paket po ID-jih ali stran — pretočene kot polje JSON. Na voljo tudi na /schemas/{schema_name}. Sklici na slike se razrešijo v URL-je, in ko je nastavljena vrednost language, se ustrezni prevod združi z osnovno vsebino.

Avtentikacija: Ključ API. Ključ je potreben samo, ko strežnik nastavi require_schema_api_key = true; sicer so anonimna branja dovoljena.

Parametri poti

ParameterVrstaZahtevanoOpombe
schema_namenizdaShema dokumenta, npr. post.

Poizvedbeni parametri

ParameterVrstaZahtevanoOpombe
websiteIduuidneCiljno spletno mesto; privzeto se uporabi glava / konfiguracija Host.
iduuidnePridobi posamezen dokument. Ima prednost pred ids.
idsnizneZ vejico ločeni UUID-ji (paket, največ 200). Ima prednost pred paginacijo.
languagenizneZdruži prevod za to lokacijo preko osnovne vsebine.
limitcelo številoneVelikost strani, privzeto 200, omejeno na 200.
offsetcelo številoneŠtevilo vrstic za preskok (uporabi se le pri pozitivni omejitvi).
api_keynizneAlternativa glavi x-api-key.

Ko nista nastavljena niti id niti ids, se dokumenti vrnejo v vrstnem redu published_at DESC.

Odgovor

Pretočno polje JSON. Vsak element predstavlja objavljeno vsebino dokumenta na najvišji ravni, z dodanimi ključi _id, _title in _publishedAt:

[
  {
    "_id": "...",
    "_title": "Kako začeti",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Kako začeti",
    "description": "...",
    "content": "..."
  }
]

Polja vsebine imajo prednost pred vbrizganimi ključi ob koliziji. Sklici na slike oblike { alt, _asset: { id } } dobijo razrešen url, vstavljen v _asset.

Primer

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

Napake

  • 400 — neveljaven websiteId, neveljaven id ali napačni ids (prazni, več kot 200 ali neveljaven UUID)
  • 401 — neveljaven ključ API (ali manjka, ko je zahtevan)
  • 500 — napaka poizvedbe
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›