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 ScaffoldingBibliotecă media

Fără interfață

Pornire rapidăSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

Prezentare generală API RESTgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetObține blocuri cu cache CELgetGET /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

Rezolvă o singură rută după calea URL, cu potrivire parametrică și documente de parametri validate.

Rezolvă o singură rută pentru o cale dată. O potrivire exactă a căii are prioritate; altfel, este selectat cel mai bine punctat model parametric, parametrii asociați sunt validați în raport cu documentele, iar blocurile efective sunt calculate. Opțional, returnează documentele parametrilor rezolvați.

Autentificare: Cheie API (antet x-api-key sau parametru de interogare api_key).

Parametri de interogare

ParametruTipObligatoriuObservații
websiteIduuiddaSite țintă.
pathstringdaCalea URL de rezolvat, de ex. /docs/getting-started.
api_keystringnuAlternativă la antetul x-api-key.
previewbooleannuImplicit false. Când este true, se rezolvă împotriva conținutului de ciornă și nu necesită documente publicate.
skipValidationbooleannuImplicit false. Când este true, erorile de validare a parametrilor nu produc un 404.

Răspuns

{
  "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 are aceeași structură ca o intrare din GET /routes. resolvedParams este prezent doar atunci când ruta are legări de parametri și cel puțin un document rezolvat. Parametrii legați la schema language se rezolvă pe baza unei liste integrate de limbi acceptate, nu a bazei de date.

Exemplu

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

Erori

  • 400 — websiteId lipsă/invalid, sau path lipsă/gol
  • 401 — cheie API invalidă
  • 404 — ruta nu a fost găsită sau validarea parametrilor a eșuat (cu excepția cazului în care skipValidation=true)
Continue Reading
Previous‹GET /routesNextGET /blocks›