REST API Overview

Profound CMS REST API leveres av Rust-tjenesten translation_manager. Den eksponerer headless lese-/strømendepunkter som brukes av renderer, samt skriveendepunkter for innhold, oversettelse og CSV-import.

Alle eksempler bruker {CMS_API_URL} som base-URL for verten til CMS-API-en din (for eksempel https://cms.dev.tryprofound.com). Det finnes ingen global sti-prefiks — rutene monteres i roten, f.eks. {CMS_API_URL}/routes.

Autentisering

API-et bruker to separate ordninger avhengig av endepunktet.

API-nøkkel (headless-lesinger + oppdatering av variant)

Send nøkkelen som x-api-key-header eller som spørreparameteren api_key:

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

Nøkler valideres mot WorkOS og mellomlagres kort i minnet. For lese-endepunkter kreves en API-nøkkel bare når serveren setter require_schema_api_key = true; ellers er anonyme lesinger tillatt. Oppdatering av variant (PATCH /dataset/{schema_name}) krever alltid en gyldig nøkkel med content_write-tillatelsen.

Bruker API-nøkkel-autentisering: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

Administrasjonsendepunkter krever en WorkOS-bruker-JWT:

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

Bruker Bearer-autentisering: /translation, /translations, /usage, /csv.

Fastslå nettstedet (leietaker)

Endepunkter med API-nøkkel fastslår målnettstedet i denne rekkefølgen:

1. Spørreparameteren ?websiteId=<uuid>
2. Host-headeren, matchet mot et konfigurert domenenavn for nettstedet
3. CMS_WEBSITE_ID-reserve (single-tenant / lokal utvikling)

Hvis ingen av dem løses til en gyldig UUID, returnerer endepunktet 400.

Feilmodell

Helsesjekk

GET {CMS_API_URL}/health returnerer { "status": "ok" } og krever ingen autentisering — bruk den til liveness-prober.