profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingBibliotecă media

Fără interfață

Pornire rapidăSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

Prezentare generală API RESTgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetObține blocuri cu cache CELgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Prezentare generală API REST

URL de bază, scheme de autentificare, rezolvarea chiriașului și modelul de erori pentru API-ul REST al CMS-ului.

API-ul REST Profound CMS este oferit de serviciul Rust translation_manager. Acesta expune endpoint-uri headless de citire/stream folosite de renderer, plus endpoint-uri de scriere pentru conținut, traducere și import CSV.

Toate exemplele folosesc {CMS_API_URL} ca URL de bază al gazdei API-ului CMS (de exemplu https://cms.dev.tryprofound.com). Nu există un prefix global de cale — rutele sunt montate la rădăcină, de ex. {CMS_API_URL}/routes.

Autentificare

API-ul folosește două scheme separate în funcție de endpoint.

Cheie API (citiri headless + upsert de variantă)

Trimite cheia ca antet x-api-key sau ca parametru de interogare api_key:

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

Cheile sunt validate prin WorkOS și puse temporar în cache în memorie. Pentru endpoint-urile de citire, o cheie API este necesară doar atunci când serverul setează require_schema_api_key = true; în caz contrar, sunt permise citirile anonime. Upsert-ul variantei (PATCH /dataset/{schema_name}) necesită întotdeauna o cheie validă care deține permisiunea content_write.

Folosește autentificare cu cheie API: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Bearer JWT (WorkOS)

Endpoint-urile de administrare necesită un JWT de utilizator WorkOS:

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

Folosește autentificare Bearer: /translation, /translations, /usage, /csv.

Rezolvarea site-ului (chiriașului)

Endpoint-urile cu cheie API identifică site-ul țintă în această ordine:

  1. Parametrul de interogare ?websiteId=<uuid>
  2. Antetul Host, potrivit cu un domeniu de site configurat
  3. Fallback-ul CMS_WEBSITE_ID (single-tenant / dezvoltare locală)

Dacă niciuna nu se rezolvă într-un UUID valid, endpoint-ul returnează 400.

Model de erori

StareSemnificație
400Cerere nevalidă — websiteId lipsă/nevalid, UUID nevalid sau eșec la validare
401Credențiale lipsă sau nevalide
403Autentificat, dar lipsește o permisiune necesară
404Resursă negăsită
500Eroare internă / de bază de date

Verificare de sănătate

GET {CMS_API_URL}/health returnează { "status": "ok" } și nu necesită autentificare — folosiți-l pentru probe de vitalitate.

Continue Reading
NextConnect your website›