GET /route

Определяет один маршрут для заданного пути. При точном совпадении пути он имеет приоритет; иначе выбирается параметрический шаблон с наивысшим рейтингом, его связанные параметры проверяются по документам, и вычисляются эффективные блоки. По желанию возвращает документы разрешённых параметров.

Аутентификация: ключ API (заголовок x-api-key или параметр запроса api_key).

Параметры запроса

Ответ

{
  "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 имеет ту же структуру, что и запись из GET /routes. resolvedParams присутствует только тогда, когда у маршрута есть привязки параметров и разрешён хотя бы один документ. Параметры, привязанные к схеме language, сопоставляются со встроенным списком поддерживаемых языков, а не с базой данных.

Пример

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

Ошибки

• 400 — отсутствует/некорректный websiteId или отсутствует/пустой path
• 401 — неверный ключ API
• 404 — маршрут не найден или проверка параметров не прошла (если skipValidation=true, код не возвращается)