profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsKomponenttyperSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyScripting i skabelonbyggerenProject ScaffoldingMediebibliotek

Headless

HurtigstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API-oversigtgetConnect 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

Løs en enkelt rute via URL-sti med parametrisk matchning og validerede parameterdokumenter.

Løs en enkelt rute for en given sti. Et nøjagtigt sti-match vinder; ellers vælges det parametriske mønster med den højeste score, dets bundne parametre valideres mod dokumenter, og de effektive blokke beregnes. Returnerer valgfrit de opløste parameterdokumenter.

Godkendelse: API-nøgle (x-api-key-header eller api_key-forespørgselsparameter).

Forespørgselsparametre

ParameterTypePåkrævetNoter
websiteIduuidjaMålwebsted.
pathstringjaURL-sti der skal løses, f.eks. /docs/getting-started.
api_keystringnejAlternativ til x-api-key-headeren.
previewbooleannejStandard false. Når true, løses der mod kladdeindhold og kræver ikke publicerede dokumenter.
skipValidationbooleannejStandard false. Når true, medfører parametervalideringsfejl ikke 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": "United States", "published_content": {} }
    }
  }
}

route har samme form som en post fra GET /routes. resolvedParams er kun til stede, når ruten har parameterbindinger og mindst ét dokument er løst. Parametre bundet til language-skemaet løses mod en indbygget liste over understøttede sprog i stedet for databasen.

Eksempel

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

Fejl

  • 400 — manglende/ugyldig websiteId, eller manglende/tom path
  • 401 — ugyldig API-nøgle
  • 404 — rute ikke fundet, eller parametervalidering mislykkedes (medmindre skipValidation=true)
Continue Reading
Previous‹GET /routesNextGET /blocks›