profound-logoProfound CMS
โŒ˜K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with Components๊ตฌ์„ฑ ์š”์†Œ ์œ ํ˜•Setup server sent events (SSE) content refetch์–ด๋“œ๋ฏผ ํŒจ๋„ ํ”„๋ก์‹œ ์„ค์ •ํ…œํ”Œ๋ฆฟ ๋นŒ๋”์—์„œ ์Šคํฌ๋ฆฝํŒ…Project Scaffolding๋ฏธ๋””์–ด ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ

Headless

Quick startjson๊ณผ Claude ์ฝ”๋“œ์ปดํฌ๋„ŒํŠธ Zod ๊ฐ€์ ธ์˜ค๊ธฐ

REST API

REST API ๊ฐœ์š”get์›น์‚ฌ์ดํŠธ๋ฅผ CMS API์— ์—ฐ๊ฒฐํ•˜๊ธฐget๊ฒฝ๋กœ ๊ฐ€์ ธ์˜ค๊ธฐget๋ผ์šฐํŠธ ๊ฐ€์ ธ์˜ค๊ธฐget๋ธ”๋ก ๊ฐ€์ ธ์˜ค๊ธฐgetCEL ์บ์‹œ๊ฐ€ ํฌํ•จ๋œ ๋ธ”๋ก ๊ฐ€์ ธ์˜ค๊ธฐget๋ธ”๋ก ์ƒ์„ฑ ๊ฐ€์ ธ์˜ค๊ธฐget์ปดํฌ๋„ŒํŠธ ๊ฐ€์ ธ์˜ค๊ธฐgetGET /components/{name}get๋ฐ์ดํ„ฐ์…‹ ์Šคํ‚ค๋งˆ ์ด๋ฆ„ ๊ฐ€์ ธ์˜ค๊ธฐgetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}post๊ฒŒ์‹œ๋ฌผ ๋ฒˆ์—ญpatch๋ฒˆ์—ญ ํŒจ์น˜get์‚ฌ์šฉ๋Ÿ‰ ๊ฐ€์ ธ์˜ค๊ธฐpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

๋ฌธ์„œ id๋ฅผ ํ‚ค๋กœ ํ•˜๋Š” ์ปค์Šคํ…€ ์ปดํฌ๋„ŒํŠธ์˜ ๋ฌธ์„œ ๋ณ€ํ˜•์„ ์—…์„œํŠธํ•ฉ๋‹ˆ๋‹ค.

๋ฌธ์„œ id๋ฅผ ํ‚ค๋กœ ํ•˜๋Š” ์ปค์Šคํ…€ ์ปดํฌ๋„ŒํŠธ์˜ ๋ณ€ํ˜•( documents ํ–‰)์„ ์—…์„œํŠธํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ์กด ๋ณ€ํ˜•์„ ์—…๋ฐ์ดํŠธํ•˜๋ ค๋ฉด id๋ฅผ ์ œ๊ณตํ•˜๊ณ , ์ƒˆ ๋ณ€ํ˜•์„ ์‚ฝ์ž…ํ•˜๋ ค๋ฉด ์ƒ๋žตํ•˜์„ธ์š”. /schemas/{schema_name}์—์„œ๋„ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ฝ˜ํ…์ธ ๋Š” ์ปดํฌ๋„ŒํŠธ์˜ ์Šคํ‚ค๋งˆ์— ๋”ฐ๋ผ ๊ฒ€์ฆ๋ฉ๋‹ˆ๋‹ค.

์ธ์ฆ: API ํ‚ค โ€” ํ•ญ์ƒ ํ•„์š”ํ•˜๋ฉฐ, ํ‚ค์—๋Š” content_write ๊ถŒํ•œ์ด ํฌํ•จ๋˜์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

๊ฒฝ๋กœ ๋งค๊ฐœ๋ณ€์ˆ˜

๋งค๊ฐœ๋ณ€์ˆ˜์œ ํ˜•ํ•„์ˆ˜๋น„๊ณ 
schema_name๋ฌธ์ž์—ด์˜ˆ์ปค์Šคํ…€ ์ปดํฌ๋„ŒํŠธ ์ด๋ฆ„์ž…๋‹ˆ๋‹ค.

์ฟผ๋ฆฌ ๋งค๊ฐœ๋ณ€์ˆ˜

๋งค๊ฐœ๋ณ€์ˆ˜์œ ํ˜•ํ•„์ˆ˜๋น„๊ณ 
websiteIduuid์•„๋‹ˆ์š”๋Œ€์ƒ ์›น์‚ฌ์ดํŠธ์ž…๋‹ˆ๋‹ค; ๊ธฐ๋ณธ์ ์œผ๋กœ Host ํ—ค๋”/๊ตฌ์„ฑ์œผ๋กœ ๋Œ€์ฒด๋ฉ๋‹ˆ๋‹ค.
api_key๋ฌธ์ž์—ด์•„๋‹ˆ์š”x-api-key ํ—ค๋”์˜ ๋Œ€์•ˆ์ž…๋‹ˆ๋‹ค.

์š”์ฒญ ๋ณธ๋ฌธ

{
  "id": "<uuid>",
  "title": "๋‚ด ๋ณ€ํ˜•",
  "content": { "title": "์•ˆ๋…•ํ•˜์„ธ์š”", "body": "..." }
}
ํ•„๋“œ์œ ํ˜•ํ•„์ˆ˜๋น„๊ณ 
iduuid์•„๋‹ˆ์š”์กด์žฌํ•  ๊ฒฝ์šฐ ์ผ์น˜ํ•˜๋Š” ๋ณ€ํ˜•์„ ์—…๋ฐ์ดํŠธํ•˜๊ณ , ์—†๊ฑฐ๋‚˜ ์ฐพ์„ ์ˆ˜ ์—†๋Š” ๊ฒฝ์šฐ ์‚ฝ์ž…ํ•ฉ๋‹ˆ๋‹ค.
title๋ฌธ์ž์—ด์•„๋‹ˆ์š”ํ‘œ์‹œ ์ œ๋ชฉ์ž…๋‹ˆ๋‹ค. ์‚ฝ์ž… ์‹œ ๊ธฐ๋ณธ๊ฐ’์€ "Untitled"์ด๋ฉฐ, ์—…๋ฐ์ดํŠธ ์‹œ ์ƒ๋žตํ•˜๋ฉด ๋ณ€๊ฒฝ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.
content๊ฐ์ฒด์˜ˆ์ปดํฌ๋„ŒํŠธ์˜ ์Šคํ‚ค๋งˆ์— ๋”ฐ๋ผ ๊ฒ€์ฆ๋˜๋Š” ํ•„๋“œ ๊ฐ’์ž…๋‹ˆ๋‹ค. JSON ๊ฐ์ฒด์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.

์‘๋‹ต

{
  "id": "...",
  "schema_name": "๊ฒŒ์‹œ๋ฌผ",
  "title": "๋‚ด ๋ณ€ํ˜•",
  "status": "์ดˆ์•ˆ",
  "version": 2,
  "created": true
}

created๋Š” ์‚ฝ์ž… ์‹œ(HTTP 201) true์ด๊ณ , ์—…๋ฐ์ดํŠธ ์‹œ(HTTP 200) false์ž…๋‹ˆ๋‹ค.

์˜ˆ์‹œ

curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>' \
  -H 'Content-Type: application/json' \
  -d '{"content":{"title":"์•ˆ๋…•ํ•˜์„ธ์š”"}}'

์˜ค๋ฅ˜

  • 400 โ€” ์ž˜๋ชป๋œ websiteId, ๊ฐ์ฒด๊ฐ€ ์•„๋‹Œ content, ์•Œ ์ˆ˜ ์—†๊ฑฐ๋‚˜ ๋ณด๊ด€๋œ ์ปดํฌ๋„ŒํŠธ, ๋˜๋Š” ๊ฒ€์ฆ ์‹คํŒจ
  • 401 โ€” ๋ˆ„๋ฝ๋˜์—ˆ๊ฑฐ๋‚˜ ์ž˜๋ชป๋œ API ํ‚ค
  • 403 โ€” ํ‚ค์— content_write ๊ถŒํ•œ์ด ์—†์Šต๋‹ˆ๋‹ค
  • 404 โ€” id๊ฐ€ ์ œ๊ณต๋˜์—ˆ์œผ๋‚˜ ์ผ์น˜ํ•˜๋Š” ๋ณ€ํ˜•์ด ์—†์Œ
Continue Reading
Previousโ€นGET /content-changes (SSE)Next๊ฒŒ์‹œ๋ฌผ ๋ฒˆ์—ญโ€บ