profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametriskā maršrutēšanaKomponentu veidiSetup server sent events (SSE) content refetchIestatīt administratora paneļa starpniekserveriSkriptēšana veidņu veidotājāProject ScaffoldingMultivides bibliotēka

Headless

Ātrā uzsākšanaSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetSaņemt maršrutusgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPēctulkošanapatchTulkojumu labojumigetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /route

Atrisina vienu maršrutu pēc URL ceļa ar parametrisko atbilstību un validētiem parametru dokumentiem.

Atrisina vienu maršrutu dotajam ceļam. Ja atrodas precīza ceļa atbilstība, tā uzvar; pretējā gadījumā tiek izvēlēts visaugstāk novērtētais parametriskais raksts, tā piesaistītie parametri tiek validēti pret dokumentiem, un tiek aprēķināti efektīvie bloki. Pēc izvēles atgriež atrisinātos parametru dokumentus.

Autentifikācija: API atslēga (x-api-key galvene vai api_key vaicājuma parametrs).

Vaicājuma parametri

ParametrsTipsObligātsPiezīmes
websiteIduuidjāMērķa tīmekļa vietne.
pathstringjāURL ceļš, ko atrisināt, piem., /docs/getting-started.
api_keystringnēAlternatīva x-api-key galvenei.
previewbooleannēNoklusējums false. Ja true, atrisina pēc melnraksta satura un neprasa publicētus dokumentus.
skipValidationbooleannēNoklusējums false. Ja true, parametru validācijas kļūmes neizraisa 404.

Atbilde

{
  "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 ir tāda pati struktūra kā ierakstam no GET /routes. resolvedParams ir pieejams tikai tad, ja maršrutam ir parametru sasaistes un atrisināts vismaz viens dokuments. Parametri, kas piesaistīti shēmai language, tiek atrisināti pēc iebūvēta atbalstīto valodu saraksta, nevis datubāzes.

Piemērs

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

Kļūdas

  • 400 — trūkst vai ir nederīgs websiteId, vai trūkst/tukšs path
  • 401 — nederīga API atslēga
  • 404 — maršruts nav atrasts vai parametru validācija neizdevās (ja vien skipValidation=true)
Continue Reading
Previous‹Saņemt maršrutusNextGET /blocks›