profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchΡύθμιση διακομιστή μεσολάβησης πίνακα διαχείρισηςCEL Scripting in Template BuilderProject ScaffoldingΒιβλιοθήκη πολυμέσων

Χωρίς κεφαλή

Γρήγορη εκκίνησηjson και Claude κώδικαςComponent Zod Pull

REST API

επισκόπηση του REST APIgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetΛήψη μπλοκ με cel cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getΛήψη ονόματος σχήματος συνόλου δεδομένωνgetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /route

Επιλύστε μία μόνο διαδρομή βάσει διαδρομής URL, με παραμετρική αντιστοίχιση και επικυρωμένα έγγραφα παραμέτρων.

Επιλύει μία μόνο διαδρομή για ένα συγκεκριμένο μονοπάτι. Μια ακριβής αντιστοίχιση μονοπατιού υπερισχύει· διαφορετικά επιλέγεται το παραμετρικό μοτίβο με την υψηλότερη βαθμολογία, οι δεσμευμένες παράμετροί του επικυρώνονται έναντι των εγγράφων και υπολογίζονται τα τελικά μπλοκ. Προαιρετικά επιστρέφει τα έγγραφα παραμέτρων που επιλύθηκαν.

Auth: Κλειδί API (κεφαλίδα x-api-key ή παράμετρος ερωτήματος api_key).

Παράμετροι ερωτήματος

ΠαράμετροςΤύποςΥποχρεωτικήΣημειώσεις
websiteIduuidyesΙστότοπος προορισμού.
pathstringyesΔιαδρομή URL προς επίλυση, π.χ. /docs/getting-started.
api_keystringnoΕναλλακτική στην κεφαλίδα x-api-key.
previewbooleannoΠροεπιλογή false. Όταν είναι true, γίνεται επίλυση με βάση πρόχειρο περιεχόμενο και δεν απαιτούνται δημοσιευμένα έγγραφα.
skipValidationbooleannoΠροεπιλογή 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)
Continue Reading
Previous‹GET /routesNextGET /blocks›