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 ScaffoldingMedia Library

Headless

Quick startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /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

GET /route

FaststÀll en enskild rutt via en URL-sökvÀg med parametrisk matchning och validerade parameterdokument.

FaststÀll en enskild rutt för en angiven sökvÀg. En exakt sökvÀgsmatchning vinner; annars vÀljs det parametriska mönster som har högst poÀng, dess bundna parametrar valideras mot dokument och de effektiva blocken berÀknas. Returnerar vid behov de upplösta parameterdokumenten.

Autentisering: API-nyckel (x-api-key-header eller api_key-frÄgeparameter).

FrÄgeparametrar

ParameterTypObligatoriskAnteckningar
websiteIduuidjaMÄlwebbplats.
pathstringjaURL-sökvÀg att lösa upp, t.ex. /docs/getting-started.
api_keystringnejAlternativ till x-api-key-headern.
previewbooleannejStandardvÀrde false. NÀr true löses mot utkastinnehÄll och publicerade dokument krÀvs inte.
skipValidationbooleannejStandardvÀrde false. NÀr true leder misslyckade parametervalideringar inte till 404.

Svar

{
  "route": {
    "path": "/docs/us/guide",
    "pattern": "/docs/{country}/guide",
    "block_ids": ["..."],
    "state": "Live",
    "param_bindings": { "country": "country" }
  },
  "resolvedParams": {
    "country": {
      "value": "us",
      "schemaName": "country",
      "document": { "id": "...", "schema_name": "country", "title": "Förenta staterna", "published_content": {} }
    }
  }
}

route har samma struktur som en post frÄn GET /routes. resolvedParams finns bara nÀr rutten har parameterbindningar och minst ett dokument har lösts. Parametrar som Àr bundna till schemat language löses mot en inbyggd lista över sprÄk som stöds i stÀllet för mot databasen.

Exempel

curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
  -H 'x-api-key: <key>'

Fel

  • 400 — saknat/ogiltigt websiteId, eller saknad/tom path
  • 401 — ogiltig API-nyckel
  • 404 — rutt hittades inte, eller parametervalidering misslyckades (om inte skipValidation=true)
Continue Reading
Previousâ€čGET /routesNextGET /blocksâ€ș