REST API Overview

Profound CMS-i REST API-d teenindab Rustis töötav teenus translation_manager. See pakub renderdaja kasutatavaid ilma kasutajaliideseta lugemis- ja voolõpp-punkte ning lisaks kirjutuslõpp-punkte sisu, tõlgete ja CSV-impordi jaoks.

Kõik näited kasutavad {CMS_API_URL} sinu CMS-i API-hostinime baas-URL-ina (näiteks https://cms.dev.tryprofound.com). Globaalse teeraja prefiksit ei ole — marsruudid on juuretasandil, nt {CMS_API_URL}/routes.

Autentimine

API kasutab sõltuvalt lõpp-punktist kahte erinevat skeemi.

API-võti (ilma kasutajaliideseta lugemised + variandi lisamine või uuendamine)

Saada võti päises x-api-key või päringu parameetrina api_key:

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

Võtmeid valideeritakse WorkOS-i vastu ja neid hoitakse lühiajaliselt mälus. Lugevate lõpp-punktide jaoks on API-võtit vaja ainult siis, kui server seab require_schema_api_key = true; vastasel juhul on anonüümsed lugemised lubatud. Variandi lisamine või uuendamine (PATCH /dataset/{schema_name}) nõuab alati kehtivat võtit, millel on content_write õigus.

API-võtme autentimist kasutavad: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

Halduslõpp-punktid nõuavad WorkOS-i kasutaja JWT-d:

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

Bearer-autentimist kasutavad: /translation, /translations, /usage, /csv.

Veebisaidi (rentniku) tuvastamine

API-võtme lõpp-punktid määravad sihtveebisaidi järgmises järjekorras:

1. Päringu parameeter ?websiteId=<uuid>
2. Host-päis, mida võrreldakse seadistatud veebisaidi domeeniga
3. Tagavara CMS_WEBSITE_ID (ühe rentnikuga / kohalik arendus)

Kui ükski neist ei anna kehtivat UUID-d, tagastab lõpp-punkt koodi 400.

Veateadete mudel

Tervisekontroll

GET {CMS_API_URL}/health tagastab { "status": "ok" } ja ei vaja autentimist — kasuta seda elususe kontrollideks.