imx.Platform

Content Delivery API

GraphQL

Offen, performant, präzise: Die Content Delivery API (GraphQL) der imx.Platform stellt alle Dienste bereit, die für die Nutzung und Integration von Inhalten in Drittsysteme benötigt werden. So wird aus zentral gepflegten Daten eine flexible, leistungsstarke Grundlage für individuelle Anwendungen, Portale und digitale Services.

Im Detail

Designziele

Vorteile

API-Technologie in der imx.Platform
Technologisch basiert die API zur imx.Platform auf GraphQL – welche es erlaubt, sehr gezielte Anfragen und das gewünschte Antwortformat durch den API-Nutzer zu formulieren. Jede Anfrage erhält genau die Informationen als Antwort zurück, die im jeweiligen Kontext benötigt werden. Darauf aufbauend können fachlich APIs konstruiert werden – und nicht rein technisch getriebene Schnittstellen, wie sie häufig mit REST, HATEOAS oder einfach auch nur HTTP implementiert werden.

Die Content Delivery API (GraphQL) der imx.Platform verfolgt folgende Designziele:

Unterstützung beliebiger Nutzungsszenarien bzw. –kanäle in der Auslieferung von Inhalten z.B. direkte Client-2-Server Kommunikation
Hohe Performance, Skalierbarkeit und Resilienz
- direkte Nutzung ohne zusätzlichen Wrapper möglich
Ermöglichen eines fachlicheren API-Design
Flexibles Antwortformat exakt für den jeweiligen Anwendungsfall
- Effiziente Datenabfragen (Clients können genau spezifizieren)
Erleichterungen für API-Nutzer
- Integration von impliziten Fachlogiken (z.B. Gültigkeit von Datensätzen, Datensatz-Sortierung)
- Automatische Generierung von typisierten API-Clients

Vollständiges Datenschema
Die Schnittstelle definiert für Ein-und Ausgabe ein vollständiges Datenschema. Dadurch wird zum Einen eine bestmögliche Unterstützung für API-Nutzer ermöglicht, z.B. durch Generierung von Datenmodell für API-Nutzer oder Autovervollständigung und zum Anderen die datengetriebene Weiterentwicklung der API sichergestellt.
Anwendungsfallorientierte Abfragen
Mit GraphQL kann der Client genau die Daten anfordern, die benötigt werden, und zwar in der gewünschten Struktur. Dadurch werden Requests reduziert, die bei REST-APIs häufig auftreten.
Echtzeit-Daten mit Subscriptions
GraphQL unterstützt Subscriptions, die es ermöglichen, Echtzeit-Updates von Server zu Client zu empfangen. Dadurch wird Kommunikation in Echtzeit ermöglicht.
Flexiblität
Die Technologie unterstützt die unterschiedliche Integration von anderen APIs.
Nur ein Endpunkt
Im Gegensatz zu REST, wo jede Ressource in der Regel einen eigenen Endpunkt hat, läuft bei GraphQL alles über einen einzigen Endpunkt. Die genaue Struktur und Menge der zurückgegebenen Daten wird durch die Abfrage definiert.