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

SnelstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

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

Los een enkele route op via een URL-pad, met parametrische matching en gevalideerde parameterdocumenten.

Los een enkele route op voor een opgegeven pad. Een exacte overeenkomst van het pad krijgt voorrang; anders wordt het parametrische patroon met de hoogste score geselecteerd, worden de gekoppelde parameters gevalideerd aan de hand van documenten en worden de effectieve blokken berekend. Geeft optioneel de opgeloste parameterdocumenten terug.

Auth: API-sleutel (x-api-key-header of api_key-queryparameter).

Queryparameters

ParameterTypeVereistOpmerkingen
websiteIduuidjaDoelwebsite.
pathstringjaURL-pad om op te lossen, bijv. /docs/getting-started.
api_keystringneeAlternatief voor de x-api-key-header.
previewbooleanneeStandaard false. Wanneer true, wordt er opgelost tegen conceptinhoud en zijn gepubliceerde documenten niet vereist.
skipValidationbooleanneeStandaard false. Wanneer true, leiden fouten bij parametervalidatie niet tot een 404.

Respons

{
  "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 heeft dezelfde vorm als een item uit GET /routes. resolvedParams is alleen aanwezig wanneer de route parameterbindingen heeft en er minstens één document is opgelost. Parameters die aan het language-schema zijn gekoppeld, worden opgelost aan de hand van een ingebouwde lijst met ondersteunde talen in plaats van de database.

Voorbeeld

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

Fouten

  • 400 — ontbrekende/ongeldige websiteId, of ontbrekend/leeg path
  • 401 — ongeldige API-sleutel
  • 404 — route niet gevonden, of parametervalidatie mislukt (tenzij skipValidation=true)
Continue Reading
Previous‹GET /routesNextGET /blocks›