Phân giải một tuyến duy nhất theo đường dẫn URL, với đối sánh tham số và xác thực tài liệu tham số.
Phân giải một tuyến duy nhất cho đường dẫn đã cho. Nếu có sự trùng khớp đường dẫn chính xác thì sẽ được ưu tiên; nếu không, mẫu tham số có điểm cao nhất sẽ được chọn, các tham số được liên kết của nó được kiểm tra với tài liệu và các khối hiệu lực được tính toán. Tùy chọn trả về các tài liệu tham số đã phân giải.
Xác thực: Khóa API (x-api-key header hoặc tham số truy vấn api_key).
| Tham số | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
websiteId | uuid | có | Trang web đích. |
path | string | có | Đường dẫn URL cần phân giải, ví dụ /docs/getting-started. |
api_key | string | không | Phương án thay thế cho header x-api-key. |
preview | boolean | không | Mặc định false. Khi là true, phân giải dựa trên nội dung nháp và không yêu cầu tài liệu đã xuất bản. |
skipValidation | boolean | không | Mặc định false. Khi là true, lỗi kiểm tra tham số sẽ không trả về 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 có cấu trúc giống với một mục từ GET /routes. resolvedParams chỉ xuất hiện khi tuyến có các tham số liên kết và đã phân giải được ít nhất một tài liệu. Các tham số được liên kết với schema language sẽ được phân giải dựa trên danh sách ngôn ngữ được hỗ trợ tích hợp sẵn thay vì cơ sở dữ liệu.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — thiếu hoặc websiteId không hợp lệ, hoặc thiếu/trống path401 — khóa API không hợp lệ404 — không tìm thấy tuyến, hoặc kiểm tra tham số thất bại (trừ khi skipValidation=true)