Преглед на REST API

REST API на Profound CMS се предоставя от услугата translation_manager, написана на Rust. Тя предлага headless крайни точки за четене/стрийм, използвани от рендера, както и крайни точки за запис за съдържание, превод и CSV импорт.

Всички примери използват {CMS_API_URL} като базов URL на вашия CMS API хост (например https://cms.dev.tryprofound.com). Няма глобален префикс на пътя — маршрутите са монтирани в корена, напр. {CMS_API_URL}/routes.

Удостоверяване

API използва две отделни схеми в зависимост от крайната точка.

API ключ (headless четене + upsert на варианти)

Изпратете ключа като заглавка 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; в противен случай анонимните четения са позволени. Upsert операцията за варианти (PATCH /dataset/{schema_name}) винаги изисква валиден ключ с разрешение content_write.

Използва удостоверяване с API ключ: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

Крайните точки за управление изискват WorkOS потребителски JWT:

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

Използва Bearer удостоверяване: /translation, /translations, /usage, /csv.

Разрешаване на уебсайта (наемател)

Крайните точки с API ключ определят целевия уебсайт в следния ред:

1. Параметърът на заявката ?websiteId=<uuid>
2. Заглавката Host, съпоставена с конфигуриран домейн на уебсайт
3. Резервната стойност CMS_WEBSITE_ID (single-tenant / локална разработка)

Ако никоя от опциите не се разреши до валиден UUID, крайната точка връща 400.

Модел за грешки

Проверка на състоянието

GET {CMS_API_URL}/health връща { "status": "ok" } и не изисква удостоверяване — използвайте го за проверки на жизнеността.