GET /route

URL パスで単一のルートを解決し、パラメトリックなマッチングと検証済みのパラメータドキュメントを提供します。

指定されたパスに対して単一のルートを解決します。パスが完全一致したものが優先され、一致しない場合はスコアが最も高いパラメトリックパターンが選択され、そのバインドされたパラメータがドキュメントに対して検証され、有効なブロックが計算されます。オプションで、解決されたパラメータドキュメントを返します。

認証: API キー（x-api-key ヘッダーまたは api_key クエリパラメータ）。

クエリパラメータ

パラメータ	型	必須	備考
`websiteId`	uuid	はい	対象サイト。
`path`	string	はい	解決する URL パス。例: `/docs/getting-started`。
`api_key`	string	いいえ	`x-api-key` ヘッダーの代替。
`preview`	boolean	いいえ	既定値は `false`。`true` の場合、ドラフトコンテンツに対して解決され、公開済みドキュメントは不要です。
`skipValidation`	boolean	いいえ	既定値は `false`。`true` の場合、パラメータ検証の失敗で `404` になりません。

レスポンス

{
  "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 は、そのルートにパラメータバインディングがあり、少なくとも 1 件のドキュメントが解決された場合にのみ存在します。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 の場合を除く）

Previous‹GET /routes NextGET /blocks›