GET /route

Wyznacza pojedynczą trasę według ścieżki URL, z dopasowaniem parametrycznym i zweryfikowanymi dokumentami parametrów.

Wyznacz pojedynczą trasę dla podanej ścieżki. Dokładne dopasowanie ścieżki ma pierwszeństwo; w przeciwnym razie wybierany jest wzorzec parametryczny z najwyższym wynikiem, jego powiązane parametry są weryfikowane względem dokumentów, a efektywne bloki są obliczane. Opcjonalnie zwraca rozwiązane dokumenty parametrów.

Uwierzytelnianie: Klucz API (nagłówek x-api-key lub parametr zapytania api_key).

Parametry zapytania

Parametr	Typ	Wymagany	Uwagi
`websiteId`	uuid	tak	Docelowa witryna.
`path`	string	tak	Ścieżka URL do rozwiązania, np. `/docs/getting-started`.
`api_key`	string	nie	Alternatywa dla nagłówka `x-api-key`.
`preview`	boolean	nie	Domyślnie `false`. Gdy `true`, rozwiązuje względem treści roboczych i nie wymaga opublikowanych dokumentów.
`skipValidation`	boolean	nie	Domyślnie `false`. Gdy `true`, niepowodzenia walidacji parametrów nie powodują `404`.

Odpowiedź

{
  "route": {
    "path": "/docs/us/guide",
    "pattern": "/docs/{country}/guide",
    "block_ids": ["..."],
    "state": "Aktywny",
    "param_bindings": { "country": "country" }
  },
  "resolvedParams": {
    "country": {
      "value": "us",
      "schemaName": "country",
      "document": { "id": "...", "schema_name": "country", "title": "Stany Zjednoczone", "published_content": {} }
    }
  }
}

route ma taki sam kształt jak wpis z GET /routes. resolvedParams jest obecne tylko wtedy, gdy trasa ma powiązania parametrów i co najmniej jeden dokument został rozwiązany. Parametry powiązane ze schematem language są rozwiązywane względem wbudowanej listy obsługiwanych języków, a nie bazy danych.

Przykład

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

Błędy

400 — brakujący/nieprawidłowy websiteId lub brakująca/pusta wartość path
401 — nieprawidłowy klucz API
404 — nie znaleziono trasy albo walidacja parametrów nie powiodła się (chyba że skipValidation=true)

Previous‹GET /routes NextGET /blocks›

Parametry zapytania

Parametr

Typ

Wymagany

Uwagi

websiteId

uuid

tak

Docelowa witryna.

path

string

tak

Ścieżka URL do rozwiązania, np. /docs/getting-started.

api_key

string

nie

Alternatywa dla nagłówka x-api-key.

preview

boolean

nie

Domyślnie false. Gdy true, rozwiązuje względem treści roboczych i nie wymaga opublikowanych dokumentów.

skipValidation

boolean

nie

Domyślnie false. Gdy true, niepowodzenia walidacji parametrów nie powodują 404.

Odpowiedź

{
  "route": {
    "path": "/docs/us/guide",
    "pattern": "/docs/{country}/guide",
    "block_ids": ["..."],
    "state": "Aktywny",
    "param_bindings": { "country": "country" }
  },
  "resolvedParams": {
    "country": {
      "value": "us",
      "schemaName": "country",
      "document": { "id": "...", "schema_name": "country", "title": "Stany Zjednoczone", "published_content": {} }
    }
  }
}