סקירת REST API

ממשק ה-REST של Profound CMS מסופק על ידי שירות Rust בשם translation_manager. הוא חושף נקודות קצה ללא ממשק לקריאה/הזרמה המשמשות את הרנדר, ובנוסף נקודות קצה לכתיבה עבור תוכן, תרגום וייבוא CSV.

כל הדוגמאות משתמשות ב-{CMS_API_URL} בתור כתובת הבסיס של מארח ה-API של ה-CMS (לדוגמה https://cms.dev.tryprofound.com). אין קידומת נתיב גלובלית — הנתיבים מוצמדים לשורש, למשל {CMS_API_URL}/routes.

אימות

ה-API משתמש בשתי סכמות נפרדות בהתאם לנקודת הקצה.

מפתח API (קריאות ללא ממשק + עדכון וריאנט)

שלחו את המפתח בכותרת x-api-key או בפרמטר השאילתה api_key:

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

מפתחות מאומתים מול WorkOS ומטמון זמני נשמר בזיכרון. עבור נקודות קצה של קריאה, מפתח API נדרש רק כאשר השרת מגדיר require_schema_api_key = true; אחרת, קריאות אנונימיות מותרות. עדכון וריאנט (PATCH /dataset/{schema_name}) תמיד דורש מפתח תקף בעל הרשאת content_write.

משתמש באימות באמצעות מפתח API: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

נקודות קצה לניהול דורשות JWT של משתמש WorkOS:

curl '{CMS_API_URL}/usage?orgId=<uuid>' \
  -H 'Authorization: Bearer <workos-jwt>'

משתמש באימות Bearer: /translation, /translations, /usage, /csv.

פתרון האתר (tenant)

נקודות קצה עם מפתח API פותרות את האתר היעד בסדר הבא:

1. פרמטר השאילתה ?websiteId=<uuid>
2. כותרת Host, בהתאמה לדומיין אתר שהוגדר
3. ברירת המחדל CMS_WEBSITE_ID (סביבת יחיד / פיתוח מקומי)

אם אף אחת מהאפשרויות לא מתפתחת ל-UUID תקף, נקודת הקצה מחזירה 400.

מודל שגיאות

בדיקת בריאות

GET {CMS_API_URL}/health מחזיר { "status": "ok" } ואינו דורש אימות — השתמשו בו לבדיקות חיים.