REST API Overview

Profound CMS REST API levereras av Rust-tjänsten translation_manager. Den tillhandahåller headless-läs-/strömändpunkter som används av renderaren samt skrivändpunkter för innehåll, översättning och CSV-import.

Alla exempel använder {CMS_API_URL} som bas-URL för din CMS API-värd (till exempel https://cms.dev.tryprofound.com). Det finns inget globalt sökvägsprefix — rutter monteras i roten, t.ex. {CMS_API_URL}/routes.

Autentisering

API:t använder två separata scheman beroende på ändpunkt.

API-nyckel (headless-läsningar + variant-upsert)

Skicka nyckeln som headern x-api-key eller som frågeparametern api_key:

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

Nycklar valideras mot WorkOS och cachas kortvarigt i minnet. För läs-ändpunkter krävs en API-nyckel endast när servern sätter require_schema_api_key = true; annars tillåts anonyma läsningar. Variant-upsert (PATCH /dataset/{schema_name}) kräver alltid en giltig nyckel med behörigheten content_write.

Använder API-nyckelautentisering: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

Administrationsändpunkter kräver en WorkOS-användar-JWT:

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

Använder Bearer-autentisering: /translation, /translations, /usage, /csv.

Fastställa webbplatsen (tenant)

Ändpunkter med API-nyckel avgör målwebbplatsen i denna ordning:

1. Frågeparametern ?websiteId=<uuid>
2. Host-headern, matchad mot en konfigurerad webbplatsdomän
3. Reservvärdet CMS_WEBSITE_ID (single-tenant / lokal utveckling)

Om inget av alternativen ger ett giltigt UUID returnerar ändpunkten 400.

Felmodell

Hälsokontroll

GET {CMS_API_URL}/health returnerar { "status": "ok" } och kräver ingen autentisering — använd den för liveness-kontroller.