profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyScripts dans le générateur de modèlesProject ScaffoldingBibliothèque multimédia

Sans interface

Démarrage rapideSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /route

Résoudre une route unique par chemin d'URL, avec correspondance paramétrique et documents de paramètres validés.

Résoudre une seule route pour un chemin donné. Une correspondance exacte du chemin l'emporte ; sinon, le motif paramétrique ayant le meilleur score est sélectionné, ses paramètres liés sont validés par rapport aux documents et les blocs effectifs sont calculés. Renvoie facultativement les documents de paramètres résolus.

Auth. : Clé API (en-tête x-api-key ou paramètre de requête api_key).

Paramètres de requête

ParamètreTypeObligatoireRemarques
websiteIduuidouiSite web cible.
pathstringouiChemin d'URL à résoudre, par exemple /docs/getting-started.
api_keystringnonAlternative à l'en-tête x-api-key.
previewbooleannonValeur par défaut false. Lorsque true, résout le contenu brouillon et ne nécessite pas de documents publiés.
skipValidationbooleannonValeur par défaut false. Lorsque true, les échecs de validation des paramètres ne renvoient pas 404.

Réponse

{
  "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 a la même structure qu'une entrée de GET /routes. resolvedParams est présent uniquement lorsque la route possède des liaisons de paramètres et qu'au moins un document est résolu. Les paramètres liés au schéma language se résolvent à partir d'une liste intégrée de langues prises en charge plutôt que depuis la base de données.

Exemple

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

Erreurs

  • 400 — websiteId manquant/invalide, ou path manquant/vide
  • 401 — clé API invalide
  • 404 — route introuvable, ou validation des paramètres échouée (sauf si skipValidation=true)
Continue Reading
Previous‹GET /routesNextGET /blocks›