profound-logoProfound CMS
⌘K
Admin
Theme
DokumentaceTutorialBlogPhilosophy
DokumentaceTutorialBlogPhilosophy

Hybrid

Parametrické směrováníTypes of ComponentsSetup server sent events (SSE) content refetchNastavení proxy administračního paneluCEL Scripting in Template BuilderProject ScaffoldingKnihovna médií

Headless

Rychlý startJson a claude kódComponent Zod Pull

rozhraní REST API

REST API OverviewgetPřipojení webu k API CMSgetGET /routesgetGET /routegetGET /blocksgetzískat bloky s mezipamětí CELgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPřeklad po publikacipatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /route

Vyřešte jednu trasu podle cesty URL s parametrickým párováním a ověřenými dokumenty parametrů.

Vyřeší jednu trasu pro danou cestu. Přesná shoda cesty má přednost; v opačném případě se vybere parametrický vzor s nejvyšším skóre, jeho svázané parametry se ověří vůči dokumentům a vypočítají se efektivní bloky. Volitelně vrací rozřešené dokumenty parametrů.

Autorizace: Klíč API (hlavička x-api-key nebo dotazovací parametr api_key).

Parametry dotazu

ParametrTypPovinnéPoznámky
websiteIduuidanoCílový web.
pathstringanoCesta URL k vyřešení, např. /docs/jak-zacit.
api_keystringneAlternativa k hlavičce x-api-key.
previewbooleanneVýchozí false. Pokud je true, vyhodnocuje se proti konceptům a nevyžaduje publikované dokumenty.
skipValidationbooleanneVýchozí false. Pokud je true, selhání ověření parametrů nezpůsobí 404.

Odpověď

{
  "route": {
    "path": "/docs/us/pruvodce",
    "pattern": "/docs/{country}/pruvodce",
    "block_ids": ["..."],
    "state": "Aktivní",
    "param_bindings": { "country": "country" }
  },
  "resolvedParams": {
    "country": {
      "value": "us",
      "schemaName": "country",
      "document": { "id": "...", "schema_name": "country", "title": "Spojené státy", "published_content": {} }
    }
  }
}

route má stejný tvar jako položka z GET /routes. resolvedParams je přítomné pouze tehdy, když má trasa vazby parametrů a byl rozřešen alespoň jeden dokument. Parametry svázané se schématem language se vyhodnocují vůči vestavěnému seznamu podporovaných jazyků místo databáze.

Příklad

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

Chyby

  • 400 — chybějící/neplatné websiteId, nebo chybějící/prázdná path
  • 401 — neplatný klíč API
  • 404 — trasa nenalezena nebo ověření parametrů selhalo (pokud není skipValidation=true)
Continue Reading
Previous‹GET /routesNextGET /blocks›