Pregled REST API-ja

REST API sistema Profound CMS zagotavlja rustov servis translation_manager. Ponuja brezglave končne točke za branje/pretakanje, ki jih uporablja upodobilnik, ter pisalne končne točke za vsebino, prevajanje in uvoz CSV.

Vsi primeri uporabljajo {CMS_API_URL} kot osnovni URL gostitelja vašega CMS API (na primer https://cms.dev.tryprofound.com). Ni globalne predpone poti — poti so nameščene v korenu, npr. {CMS_API_URL}/routes.

Avtentikacija

Ključ API (brezglavo branje + dodajanje/posodabljanje različice)

Pošljite ključ kot glavo x-api-key ali parameter poizvedbe api_key:

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

Ključi se preverjajo prek WorkOS in se za kratek čas predpomnijo v pomnilniku. Za bralne končne točke je ključ API potreben samo, ko strežnik nastavi require_schema_api_key = true; sicer so anonimna branja dovoljena. Posodobitev različice (PATCH /dataset/{schema_name}) vedno zahteva veljaven ključ s pravico content_write.

Uporablja overjanje s ključem API: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Žeton Bearer JWT (WorkOS)

Upravne končne točke zahtevajo uporabniški JWT WorkOS:

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

Uporablja overjanje Bearer: /translation, /translations, /usage, /csv.

Določanje spletnega mesta (najemnika)

Končne točke s ključem API določijo ciljno spletno mesto v tem vrstnem redu:

1. Parameter poizvedbe ?websiteId=<uuid>
2. Glava Host, ki se ujema s konfigurirano domeno spletnega mesta
3. Rezervni CMS_WEBSITE_ID (single-tenant / lokalni razvoj)

Če nobena od možnosti ne poda veljavnega UUID, končna točka vrne 400.

Model napak

Preverjanje delovanja

GET {CMS_API_URL}/health vrne { "status": "ok" } in ne zahteva avtentikacije — uporabite ga za preverjanje živosti.