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 proxyPisanje skripti u alatu za izradu predložakaProject ScaffoldingMedia Library

Bez sučelja

Brzi početakSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Pregled REST API-jagetPovezivanje web-stranice s CMS API-jemgetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPrijevod objavepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /route

Razriješi jednu rutu prema URL putanji, s parametarskim podudaranjem i provjerenim dokumentima parametara.

Razriješi jednu rutu za zadanu putanju. Točno podudaranje putanje ima prednost; inače se odabire parametarski uzorak s najboljim rezultatom, njegovi vezani parametri provjeravaju se u odnosu na dokumente i izračunavaju se učinkoviti blokovi. Po želji vraća razriješene dokumente parametara.

Autentikacija: API ključ (x-api-key zaglavlje ili api_key upitni parametar).

Upitni parametri

ParametarVrstaObaveznoNapomene
websiteIduuiddaCiljana web-stranica.
pathstringdaURL putanja koju treba razriješiti, npr. /docs/getting-started.
api_keystringneAlternativa zaglavlju x-api-key.
previewbooleanneZadano je false. Kada je true, razrješava se prema nacrtu sadržaja i ne zahtijeva objavljene dokumente.
skipValidationbooleanneZadano je false. Kada je true, neuspjesi provjere parametara ne rezultiraju statusom 404.

Odgovor

{
  "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": "Sjedinjene Američke Države", "published_content": {} }
    }
  }
}

route ima isti oblik kao zapis iz GET /routes. resolvedParams je prisutan samo kada ruta ima vezanja parametara i barem jedan dokument razriješen. Parametri vezani uz shemu language razrješavaju se prema ugrađenom popisu podržanih jezika umjesto prema bazi podataka.

Primjer

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

Pogreške

  • 400 — nedostaje/neispravan websiteId ili nedostaje/prazan path
  • 401 — nevažeći API ključ
  • 404 — ruta nije pronađena ili provjera parametara nije uspjela (osim ako je skipValidation=true)
Continue Reading
Previous‹GET /routesNextGET /blocks›