Parametrik eşleştirme ve doğrulanmış parametre belgeleriyle bir URL yolu üzerinden tek bir rotayı çözümler.
Belirli bir yol için tek bir rotayı çözümler. Yol tam olarak eşleşirse önceliklidir; aksi hâlde en yüksek puanlı parametrik desen seçilir, bağlanan parametreler belgelerle doğrulanır ve etkili bloklar hesaplanır. İsteğe bağlı olarak çözümlenen parametre belgelerini döndürür.
Kimlik doğrulama: API anahtarı (x-api-key üst bilgisi veya api_key sorgu parametresi).
| Parametre | Tür | Gerekli | Notlar |
|---|---|---|---|
websiteId | uuid | evet | Hedef web sitesi. |
path | string | evet | Çözümlenecek URL yolu, örn. /docs/getting-started. |
api_key | string | hayır | x-api-key üst bilgisine alternatif. |
preview | boolean | hayır | Varsayılan false. true olduğunda taslak içerik üzerinden çözümler ve yayımlanmış belgeler gerektirmez. |
skipValidation | boolean | hayır | Varsayılan false. true olduğunda parametre doğrulama hataları 404 döndürmez. |
{
"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 yanıtındaki bir kaydın aynı yapısına sahiptir. resolvedParams, rota parametre bağlamalarına sahip olduğunda ve en az bir belge çözümlendiğinde bulunur. language şemasına bağlı parametreler, veritabanı yerine desteklenen dillerin yerleşik bir listesine göre çözülür.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — eksik/geçersiz websiteId veya eksik/boş path401 — geçersiz API anahtarı404 — rota bulunamadı veya parametre doğrulaması başarısız (skipValidation=true olmadığı sürece)