Alap URL, hitelesítési sémák, a bérlő feloldása és a CMS REST API hibamodellje.
A Profound CMS REST API-t a Rust translation_manager szolgáltatás szolgálja ki. Headless olvasási/stream végpontokat tesz elérhetővé a renderelő számára, valamint írási végpontokat a tartalomhoz, a fordításhoz és a CSV-importhoz.
Minden példa a {CMS_API_URL} értéket használja a CMS API kiszolgáló alap URL-jeként (például https://cms.dev.tryprofound.com). Nincs globális útvonal-előtag — az útvonalak a gyökérre vannak felcsatolva, pl. {CMS_API_URL}/routes.
Az API két külön hitelesítési sémát használ a végponttól függően.
Küldje el a kulcsot az x-api-key fejlécben vagy az api_key lekérdezési paraméterként:
curl '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
-H 'x-api-key: <your-api-key>'
A kulcsokat a WorkOS ellenőrzi, és rövid ideig memóriában kerülnek gyorsítótárazásra. A read végpontoknál csak akkor szükséges API-kulcs, ha a szerver beállítja a require_schema_api_key = true értéket; ellenkező esetben az anonim olvasás is engedélyezett. A variáns upsert (PATCH /dataset/{schema_name}) mindig érvényes kulcsot igényel, amely rendelkezik content_write jogosultsággal.
API-kulcs alapú hitelesítést használ: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.
A menedzsment végpontok WorkOS-felhasználói JWT-t igényelnek:
curl '{CMS_API_URL}/usage?orgId=<uuid>' \
-H 'Authorization: Bearer <workos-jwt>'
Bearer alapú hitelesítést használ: /translation, /translations, /usage, /csv.
Az API-kulcsos végpontok ebben a sorrendben határozzák meg a cél webhelyet:
?websiteId=<uuid> lekérdezési paraméterHost fejléc, a konfigurált webhelytartománnyal összevetveCMS_WEBSITE_ID tartalék (single-tenant / helyi fejlesztés)Ha egyik sem oldódik fel érvényes UUID-re, a végpont 400-as hibát ad vissza.
| Állapot | Jelentés |
|---|---|
400 | Rossz kérés — hiányzó/érvénytelen websiteId, érvénytelen UUID vagy sikertelen validáció |
401 | Hiányzó vagy érvénytelen hitelesítési adatok |
403 | Hitelesítve, de hiányzik a szükséges jogosultság |
404 | Erőforrás nem található |
500 | Belső / adatbázishiba |
A GET {CMS_API_URL}/health visszaadja a { "status": "ok" } értéket, és nem igényel hitelesítést — használja élőségi vizsgálatokhoz.