Prehľad REST API

Profound CMS REST API poskytuje služba Rust translation_manager. Zverejňuje bezhlavé koncové body na čítanie/streamovanie používané vykresľovačom, ako aj koncové body na zápis obsahu, prekladu a importu CSV.

Všetky príklady používajú {CMS_API_URL} ako základnú adresu URL hostiteľa vášho rozhrania CMS API (napríklad https://cms.dev.tryprofound.com). Neexistuje žiadna globálna predpona cesty — trasy sú pripojené ku koreňu, napr. {CMS_API_URL}/routes.

Autentifikácia

API používa dva samostatné mechanizmy v závislosti od koncového bodu.

API kľúč (bezhlavé čítania + upsert variantu)

Kľúč odošlite ako hlavičku x-api-key alebo ako parameter dopytu api_key:

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

Kľúče sa overujú vo WorkOS a krátko sa ukladajú do vyrovnávacej pamäte v pamäti. Pri koncových bodoch na čítanie sa API kľúč vyžaduje iba vtedy, keď server nastaví require_schema_api_key = true; inak sú povolené anonymné čítania. Operácia upsert variantu (PATCH /dataset/{schema_name}) vždy vyžaduje platný kľúč s oprávnením content_write.

Používa overenie API kľúčom: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

Správcovské koncové body vyžadujú používateľský JWT WorkOS:

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

Používa overenie Bearer: /translation, /translations, /usage, /csv.

Určenie webovej stránky (tenant)

Koncové body s API kľúčom určujú cieľovú webovú stránku v tomto poradí:

1. Parameter dopytu ?websiteId=<uuid>
2. Hlavička Host, ktorá sa porovnáva s nakonfigurovanou doménou webovej stránky
3. Záložné nastavenie CMS_WEBSITE_ID (single-tenant / lokálny vývoj)

Ak sa nepodarí získať platné UUID, koncový bod vráti 400.

Model chýb

Kontrola stavu

GET {CMS_API_URL}/health vráti { "status": "ok" } a nevyžaduje žiadne overenie — použite ho na sondy živosti.