REST API apžvalga

Profound CMS REST API teikia Rust paslauga translation_manager. Ji pateikia be sąsajos (headless) skaitymo / srauto galutinius taškus, kuriuos naudoja atvaizdavimo modulis, taip pat rašymo galutinius taškus turiniui, vertimui ir CSV importui.

Visi pavyzdžiai naudoja {CMS_API_URL} kaip jūsų CMS API pagrindinio serverio bazinį URL (pavyzdžiui, https://cms.dev.tryprofound.com). Nėra bendro kelio priešdėlio — maršrutai montuojami šakniniame lygyje, pvz., {CMS_API_URL}/routes.

Autentifikacija

API naudoja dvi skirtingas schemas, priklausomai nuo galutinio taško.

API raktas (be sąsajos skaitymai + varianto įkėlimas)

Siųskite raktą kaip x-api-key antraštę arba api_key užklausos parametrą:

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

Raktai tikrinami per WorkOS ir trumpam talpinami atmintyje. Skaitymo galutiniams taškams API raktas reikalingas tik tada, kai serveris nustato require_schema_api_key = true; kitu atveju leidžiami anoniminiai skaitymai. Varianto įkėlimas (PATCH /dataset/{schema_name}) visada reikalauja galiojančio rakto su content_write leidimu.

Naudoja API rakto autentifikaciją: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

Valdymo galutiniams taškams reikalingas WorkOS naudotojo JWT:

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

Naudoja Bearer autentifikaciją: /translation, /translations, /usage, /csv.

Svetainės (nuomininko) nustatymas

API rakto galutiniai taškai nustato tikslinę svetainę tokia seka:

1. Užklausos parametras ?websiteId=<uuid>
2. Host antraštė, sulyginama su sukonfigūruotu svetainės domenu
3. Atsarginė reikšmė CMS_WEBSITE_ID (vieno nuomininko / vietinė kūrimo aplinka)

Jei nė viena parinktis neatitinka galiojančio UUID, galutinis taškas grąžina 400.

Klaidos modelis

Būklės patikra

GET {CMS_API_URL}/health grąžina { "status": "ok" } ir nereikalauja autentifikacijos — naudokite jį veikimo tikrinimams.