GET /route

Bestem én enkelt rute etter URL-sti, med parametrisk samsvar og validerte parameterdokumenter.

Bestem én enkelt rute for en gitt sti. Et nøyaktig stitreff vinner; ellers velges det parametriske mønsteret med høyest poengsum, de bundne parameterne valideres mot dokumenter, og de effektive blokkene beregnes. Returnerer eventuelt de løste parameterdokumentene.

Autentisering: API-nøkkel (x-api-key-header eller api_key-forespørselsparameter).

Forespørselsparametere

Parameter	Type	Påkrevd	Merknader
`websiteId`	uuid	ja	Målnettsted.
`path`	string	ja	URL-sti som skal løses, f.eks. `/docs/getting-started`.
`api_key`	string	nei	Alternativ til `x-api-key`-headeren.
`preview`	boolean	nei	Standard `false`. Når `true`, løses det mot kladdinnhold og krever ikke publiserte dokumenter.
`skipValidation`	boolean	nei	Standard `false`. Når `true`, fører ikke parametervalideringsfeil til `404`.

Svar

{
  "route": {
    "path": "/docs/us/guide",
    "pattern": "/docs/{country}/guide",
    "block_ids": ["..."],
    "state": "Aktiv",
    "param_bindings": { "country": "country" }
  },
  "resolvedParams": {
    "country": {
      "value": "us",
      "schemaName": "country",
      "document": { "id": "...", "schema_name": "country", "title": "De forente stater", "published_content": {} }
    }
  }
}

route har samme form som en oppføring fra GET /routes. resolvedParams er bare til stede når ruten har parambindinger og minst ett dokument er løst. Parametre som er bundet til language-skjemaet, løses mot en innebygd liste over støttede språk i stedet for databasen.

Eksempel

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

Feil

400 — manglende/ugyldig websiteId, eller manglende/tom path
401 — ugyldig API-nøkkel
404 — rute ikke funnet, eller parametervalidering mislyktes (med mindre skipValidation=true)

Previous‹GET /routes NextGET /blocks›