GET /route

Menentukan satu rute berdasarkan path URL, dengan pencocokan parametrik dan dokumen parameter terverifikasi.

Menentukan satu rute untuk path yang diberikan. Jika ada kecocokan path yang persis, itu yang digunakan; jika tidak, pola parametrik dengan skor terbaik dipilih, parameter terikatnya divalidasi terhadap dokumen, dan blok efektif dihitung. Secara opsional mengembalikan dokumen parameter yang terselesaikan.

Auth: API key (header x-api-key atau parameter kueri api_key).

Parameter kueri

Parameter	Tipe	Wajib	Catatan
`websiteId`	uuid	ya	Situs web target.
`path`	string	ya	Path URL yang akan diselesaikan, misalnya `/docs/getting-started`.
`api_key`	string	tidak	Alternatif untuk header `x-api-key`.
`preview`	boolean	tidak	Default `false`. Saat `true`, akan menggunakan konten draf dan tidak memerlukan dokumen yang telah dipublikasikan.
`skipValidation`	boolean	tidak	Default `false`. Saat `true`, kegagalan validasi parameter tidak menghasilkan `404`.

Respons

{
  "route": {
    "path": "/docs/us/guide",
    "pattern": "/docs/{country}/guide",
    "block_ids": ["..."],
    "state": "Aktif",
    "param_bindings": { "country": "country" }
  },
  "resolvedParams": {
    "country": {
      "value": "us",
      "schemaName": "country",
      "document": { "id": "...", "schema_name": "country", "title": "Amerika Serikat", "published_content": {} }
    }
  }
}

route memiliki bentuk yang sama seperti entri dari GET /routes. resolvedParams hanya ada ketika rute memiliki pengikatan parameter dan setidaknya satu dokumen terselesaikan. Parameter yang terikat pada skema language akan diselesaikan terhadap daftar bawaan bahasa yang didukung, bukan ke basis data.

Contoh

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

Kesalahan

400 — websiteId hilang/tidak valid, atau path hilang/kosong
401 — API key tidak valid
404 — rute tidak ditemukan, atau validasi parameter gagal (kecuali skipValidation=true)

Previous‹GET /routes NextGET /blocks›