profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchYlläpitäjän hallintapaneelin välityspalvelimen määrittäminenCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

PikakäynnistysSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST-ohjelmointirajapinta

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetKäytön hakeminenpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

Lisää tai päivitä mukautetun komponentin dokumenttivariantti, jonka avaimena on dokumentin id.

Lisää tai päivitä mukautetun komponentin variantti (rivi taulussa documents), jonka avaimena on dokumentin id. Anna id päivittääksesi olemassa olevan variantin; jätä se pois lisätäksesi uuden. Käytettävissä myös osoitteessa /schemas/{schema_name}. Sisältö validoidaan komponentin skeemaa vasten.

Todennus: API-avain — aina pakollinen, ja avaimella täytyy olla content_write-oikeus.

Polkuparametrit

ParametriTyyppiPakollinenHuomautukset
schema_namestringkylläMukautetun komponentin nimi.

Kyselyparametrit

ParametriTyyppiPakollinenHuomautukset
websiteIduuideiKohdesivusto; käyttää oletuksena Host-otsikkoa tai -määritystä.
api_keystringeiVaihtoehto x-api-key-otsikolle.

Pyyntörunko

{
  "id": "<uuid>",
  "title": "Oma variantti",
  "content": { "title": "Hei", "body": "..." }
}
KenttäTyyppiPakollinenHuomautukset
iduuideiPäivittää vastaavan variantin, kun se on annettu; lisää uuden, kun se puuttuu tai sitä ei löydy.
titlestringeiNäytön otsikko. Oletusarvo on "Untitled" lisäyksessä; päivityksessä säilyy ennallaan, jos se jätetään pois.
contentobjectkylläKenttäarvot, validoidaan komponentin skeemaa vasten. Täytyy olla JSON-objekti.

Vastaus

{
  "id": "...",
  "schema_name": "post",
  "title": "Oma variantti",
  "status": "luonnos",
  "version": 2,
  "created": true
}

created on true lisäyksessä (HTTP 201) ja false päivityksessä (HTTP 200).

Esimerkki

curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>' \
  -H 'Content-Type: application/json' \
  -d '{"content":{"title":"Hei"}}'

Virheet

  • 400 — virheellinen websiteId, ei-objekti content, tuntematon tai arkistoitu komponentti tai validointivirhe
  • 401 — puuttuva tai virheellinen API-avain
  • 403 — avaimelta puuttuu content_write-oikeus
  • 404 — id annettu, mutta vastaavaa varianttia ei löytynyt
Continue Reading
Previous‹GET /content-changes (SSE)NextPOST /translation›