Pages Endpunkt

Der Pages-API-Endpunkt ruft umfassende Informationen zu einer bestimmten Seite ab, entweder anhand eines Slugs oder eines Pfads. Der Slug ist eine eindeutige Kennung der Seite, während der Pfad der Slug mit einem vorangestellten Schrägstrich ist. Durch die Eingabe des Slugs oder des Pfads werden alle relevanten Details zur Seite ermittelt.

🔗 Dokumentation: Nitro OpenAPI

Pages werden innerhalb eines Containers hierarchisch angeordnet. Jede Page kann eine beliebige Anzahl von Inhaltselementen (Komponenten) enthalten. Die Pages können über den Slug oder Pfad aufgerufen werden und enthalten alle Daten, die für das Befüllen der Seite mit Inhalt benötigt werden. Dazu gehören alle Inhaltselemente, aber auch Meta-Informationen wie "og-descriptions". Dynamische Inhalte aus Entitäten können mittels ⟶Mapping auch in Inhaltselementen verwendet werden.

Beispiel JSON

{
  "id": 123,
  "title": "About Me",
  "href": "/about-me",
  "slug": "about-me",
  "json": [
    {
      "items": [
        {
          "title": "Hello",
          "teaser": "Great!"
        },
        {
          "title": "Hallo",
          "teaser": "Toll!"
        }
      ],
      "content": {
        "title": "Hello World"
      },
      "config": {
        "is_dark": true
      },
      "identifier": "hero_image",
      "uid": "e4244ff7-e20e-40b9-b6a1-1117206aca14",
      "component": "HeroImage",
      "slots": {
        "slot1": {
          "identifer": "slot1",
          "content": []
        }
      },
      "collection": {
        "enabled": false,
        "key": "e4244ff7-e20e-40b9-b6a1-1117206aca14",
        "per_page": 2,
        "inline_first_page": true,
        "total": 2,
        "page_count": 1,
        "current_page": 1,
        "sort": null,
        "sortable": [],
        "filterable": [],
        "links": null,
        "facets": { "_empty": true }
      }
    }
  ],
  "depth": 1,
  "is_home": 1,
  "created_at": 123456789,
  "updated_at": 123456789,
  "is_visible": 1,
  "is_indexable": 1,
  "meta_json": {
    "description": "This is a meta description",
    "image": "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg",
    "title": "Hello World"
  },
  "properties": {
    "title": {
      "value": "Hello World",
      "navigation": true,
      "propagate": false
    }
  },
  "uid": "e4244ff7-e20e-40b9-b6a1-1117206aca14",
  "type": "page",
  "target": "_self",
  "container": "default",
  "breadcrumb": [
    {
      "slug": "about-me",
      "title": "About me",
      "href": "/about-me"
    }
  ],
  "translation": [
    {
      "language": {
        "shortcode": "de",
        "name": "Deutsch"
      },
      "slug": "about-me",
      "title": "About me",
      "href": "/about-me"
    }
  ]
}

Jedes Inhaltselement trägt das Objekt collection. Ist es eine Collection (enabled: true), enthält items nur die erste Seite der Einträge, und collection.links führt zu den weiteren Seiten, siehe Content-Pool-Inhalte eines Blocks. In collection.facets stehen die Werte der aggregierten Mapping-Felder mit ihrer Anzahl, auf jedem Inhaltselement, siehe Facets.

Das Resonse-Schema mit weiteren Informationen zu den einzelnen Variablen ist in der Nitro OpenAPI zu finden.