GET /route

Разрешете единичен маршрут за даден път. При точно съвпадение на пътя то има предимство; в противен случай се избира параметричният шаблон с най-висок резултат, неговите свързани параметри се валидират спрямо документите и се изчисляват ефективните блокове. По желание връща разрешените параметърни документи.

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

Параметри на заявката

Отговор

{
  "route": {
    "path": "/docs/us/guide",
    "pattern": "/docs/{country}/guide",
    "block_ids": ["..."],
    "state": "Активен",
    "param_bindings": { "country": "country" }
  },
  "resolvedParams": {
    "country": {
      "value": "us",
      "schemaName": "country",
      "document": { "id": "...", "schema_name": "country", "title": "Съединени щати", "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)