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 מופיע רק כאשר לנתיב יש קישורי פרמטרים ולפחות מסמך אחד נפתר. פרמטרים הקשורים לסכמה 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 Nextקבלת בלוקים›

פרמטרי שאילתה

פרמטר

סוג

נדרש

הערות

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": {} }
    }
  }
}