Entities Endpunkt

Der Entities-Endpunkt liefert Einträge (Inhalte) einer bestimmten ⟶ Entität. Eine Entität stellt eine Sammlung von Informationen dar und wird durch ein Schlüssel-Wert-Paar definiert. Du kannst verschiedene Datentypen wie Blogs, Veranstaltungen oder jegliche andere relevante Daten nutzen. Um auf Einträge (Inhalte) einer Entität zugreifen zu können, muss das Mapping der entsprechenden Detailseite der Entität in der Konfiguration der Integration vorgenommen werden.

🔗 Dokumentation: Nitro OpenAPI

Beispiel für ein Response Schema (JSON)

{
  "entity": {
    "_version": 102,
    "entity_metric": {
      "api": "https://api.flyo.cloud/integration/metric/h/METRICS_HASH",
      "image": "https://api.flyo.cloud/integration/metric/h/METRICS_HASH/pixel.gif"
    },
    "entity_unique_id": "2348uc",
    "entity_id": 1234,
    "entity_image": "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg",
    "entity_slug": "news-title-1",
    "entity_teaser": "The quick brown fox jumps over the lazy dog",
    "entity_time_end": 12345678,
    "entity_time_start": 12345678,
    "entity_title": "News Title #1",
    "entity_type": "schema",
    "entity_type_id": 123,
    "updated_at": 123456789,
    "routes": {
      "detail": "view/<uniqueid>/<slug>"
    }
  },
  "model": {
    "title": "News Title #1",
    "teaser": "The quick brown fox jumps over the lazy dog",
    "slug": "news-title-1",
    "image": "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg"
  },
  "language": "de",
  "jsonld": {
    "@context": "https://schema.org/",
    "@type": "Thing",
    "name": "News Title #1",
    "description": "The quick brown fox jumps over the lazy dog",
    "image": "https://storage.flyo.cloud/integrationsgruppe-flyowebseite_7a158241.jpg"
  },
  "translation": [
    {
      "language": {
        "shortcode": "de",
        "name": "Deutsch"
      },
      "slug": "about-me",
      "title": "About me",
      "href": "/about-me"
    }
  ],
  "breadcrumb": [
    {
      "slug": "about-me",
      "title": "About me",
      "href": "/about-me"
    }
  ]
}

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

Entität anhand des Slugs und optionaler Typ-ID finden

Der entityBySlug API-Endpunkt ermöglicht das Abrufen von Entitäten basierend auf ihrem Slug und einer optionalen Entity-Type-ID für genauere Ergebnisse. Er gehört zum Entities-Tag. Der Endpunkt erfordert einen slug-Parameter, der im Pfad übergeben werden muss und für die Identifizierung der Entität notwendig ist. Da Slugs jedoch nicht einzigartig unter verschiedenen Entitäten sind, wird dringend empfohlen, auch den typeId-Parameter über die Abfrage bereitzustellen, um falsche oder unbeabsichtigte Ergebnisse zu vermeiden. Diese typeId dient als Entity-Definition-Schema-ID und gewährleistet eine präzisere und gezieltere Entitätenabfrage, indem die Entitäten klarer unterschieden werden. Der slug-Parameter ist obligatorisch und sollte ein String sein (z.B. 'hello-world'), während der typeId-Parameter optional ist und ein Integer sein sollte (z.B. 123), der die Entity-Definition-Schema-ID darstellt.