REST API-oversigt

Profound CMS REST API'en leveres af Rust-tjenesten translation_manager. Den udstiller headless læse-/stream-endpoints, som bruges af rendereren, samt skrive-endpoints til indhold, oversættelse og CSV-import.

Alle eksempler bruger {CMS_API_URL} som base-URL'en for din CMS API-vært (for eksempel https://cms.dev.tryprofound.com). Der er intet globalt sti-præfiks — ruter monteres i roden, f.eks. {CMS_API_URL}/routes.

Godkendelse

API'en bruger to separate mekanismer afhængigt af endpointet.

API-nøgle (headless læsninger + variant-upsert)

Send nøglen som x-api-key-headeren eller som forespørgselsparameteren api_key:

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

Nøgler valideres mod WorkOS og caches kortvarigt i hukommelsen. For læse-endpoints kræves en API-nøgle kun, når serveren sætter require_schema_api_key = true; ellers er anonyme læsninger tilladt. Variant-upsert (PATCH /dataset/{schema_name}) kræver altid en gyldig nøgle med rettigheden content_write.

Bruger API-nøgle-godkendelse: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

Administrations-endpoints kræver et WorkOS-bruger-JWT:

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

Bruger Bearer-godkendelse: /translation, /translations, /usage, /csv.

Identificering af websitet (tenant)

Endpoints med API-nøgle bestemmer målsitet i denne rækkefølge:

1. Forespørgselsparameteren ?websiteId=<uuid>
2. Host-headeren, matchet mod et konfigureret webdomæne
3. Fallback-værdien CMS_WEBSITE_ID (single-tenant / lokal udvikling)

Hvis ingen af dem giver en gyldig UUID, returnerer endpointet 400.

Fejlmodel

Sundhedstjek

GET {CMS_API_URL}/health returnerer { "status": "ok" } og kræver ingen godkendelse — brug den til liveness-tjek.