REST API Overview

Profound CMS REST API nodrošina Rust pakalpojums translation_manager. Tas nodrošina headless lasīšanas/plūsmas galapunktus, ko izmanto renderētājs, kā arī rakstīšanas galapunktus saturam, tulkojumiem un CSV importam.

Visos piemēros {CMS_API_URL} tiek izmantots kā jūsu CMS API resursdatora pamatadrese (piemēram, https://cms.dev.tryprofound.com). Nav globāla ceļa prefiksa — maršruti tiek publicēti saknes līmenī, piem., {CMS_API_URL}/routes.

Autentifikācija

API izmanto divas atšķirīgas shēmas atkarībā no galapunkta.

API atslēga (headless lasīšana + varianta pievienošana/atjaunināšana)

Sūtiet atslēgu x-api-key galvenē vai api_key vaicājuma parametrā:

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

Atslēgas tiek validētas pret WorkOS un īslaicīgi kešotas atmiņā. Lasīšanas galapunktiem API atslēga ir obligāta tikai tad, ja serveris iestata require_schema_api_key = true; pretējā gadījumā ir atļauta anonīma lasīšana. Varianta pievienošanai/atjaunināšanai (PATCH /dataset/{schema_name}) vienmēr nepieciešama derīga atslēga ar atļauju content_write.

Izmanto API atslēgas autentifikāciju: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

Pārvaldības galapunktiem nepieciešams WorkOS lietotāja JWT:

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

Izmanto Bearer autentifikāciju: /translation, /translations, /usage, /csv.

Vietnes (nomnieka) noteikšana

API atslēgas galapunkti mērķa vietni nosaka šādā secībā:

1. Vaicājuma parametrs ?websiteId=<uuid>
2. Galvene Host, kas tiek salīdzināta ar konfigurētu vietnes domēnu
3. Rezerves vērtība CMS_WEBSITE_ID (viena nomnieka / lokālā izstrāde)

Ja neviens nenorāda uz derīgu UUID, galapunkts atgriež 400.

Kļūdu modelis

Veselības pārbaude

GET {CMS_API_URL}/health atgriež { "status": "ok" } un neprasa autentifikāciju — izmantojiet to dzīvotspējas pārbaudēm.