Pregled REST API-ja

REST API sustava Profound CMS poslužuje Rust servis translation_manager. Izlaže bezglave krajnje točke za čitanje/streaming koje koristi renderer, kao i krajnje točke za pisanje za sadržaj, prijevod i CSV uvoz.

Svi primjeri koriste {CMS_API_URL} kao osnovni URL domaćina vašeg CMS API-ja (na primjer https://cms.dev.tryprofound.com). Nema globalnog prefiksa putanje — rute se montiraju u korijenu, npr. {CMS_API_URL}/routes.

Autentikacija

API koristi dvije odvojene sheme ovisno o krajnjoj točki.

API ključ (bezglavna čitanja + upsert varijante)

Pošaljite ključ kao zaglavlje x-api-key ili parametar upita api_key:

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

Ključevi se provjeravaju preko WorkOS-a i kratko se predmemoriraju u memoriji. Za krajnje točke čitanja API ključ je potreban samo kada poslužitelj postavi require_schema_api_key = true; inače su anonimna čitanja dopuštena. Upsert varijante (PATCH /dataset/{schema_name}) uvijek zahtijeva valjani ključ s dopuštenjem content_write.

Koristi autentikaciju API ključem: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

Upravljačke krajnje točke zahtijevaju WorkOS korisnički JWT:

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

Koristi Bearer autentikaciju: /translation, /translations, /usage, /csv.

Razrješavanje web-mjesta (stanar)

Krajnje točke koje koriste API ključ određuju ciljano web-mjesto ovim redoslijedom:

1. Parametar upita ?websiteId=<uuid>
2. Zaglavlje Host, upareno s konfiguriranom domenom web-mjesta
3. Zadano CMS_WEBSITE_ID (jedan stanar / lokalni razvoj)

Ako nijedna opcija ne rezultira valjanim UUID-om, krajnja točka vraća 400.

Model pogrešaka

Provjera stanja

GET {CMS_API_URL}/health vraća { "status": "ok" } i ne zahtijeva autentikaciju — upotrijebite ga za provjere živosti.