Oniva GraphQL API

Was ist die GraphQL API?

Die Oniva GraphQL API ermöglicht den programmatischen Zugriff auf Eventdaten – ohne die Benutzeroberfläche. Sie basiert auf GraphQL, einer flexiblen Abfragesprache, mit der gezielt definiert werden kann, welche Daten benötigt werden.

Die GraphQL API eignet sich besonders für komplexere Integrationen, bei denen mehr Flexibilität beim Abfragen von Daten benötigt wird. Für einfachere, kundenseitige Integrationen empfehlen wir die REST API – sie ist zweckgebundener aufgebaut und damit schneller in der Handhabung.

💡 Tipp: Nicht sicher, welche API die richtige ist? Die Vergleichstabelle am Ende dieses Artikels hilft dir bei der Entscheidung.

‍

Was ist über die GraphQL API möglich?

Typische Anwendungsfälle der GraphQL API sind:

Event-Import: Eventdetails abrufen, um bevorstehende Events auf anderen Plattformen anzuzeigen.

Teilnehmerzugriffe: Gästeliste und Check-in-Status abrufen – z. B. für das Eventmanagement vor Ort.

Individuelle Integrationen: Massgeschneiderte Lösungen für spezifische Anforderungen entwickeln, die über Standardfunktionen hinausgehen.

‍

Zugang zur GraphQL API

Endpoint-URL

Die Basis-URL für den Zugriff auf die API lautet:

/api/graphql

Authentifizierung

Für den Zugriff auf die API wird ein App-Token-Schlüssel benötigt:

• Der App-Token-Schlüssel kann vom Oniva-Support bereitgestellt oder über die Admin-Oberfläche erstellt werden
• Ein App-Token gilt immer für alle Events eines Workspaces
• Für benutzerspezifische Integrationen stehen Event-Tokens und weitere Authentifizierungsmethoden zur Verfügung

‍

Funktionsweise

GraphQL-Anfragen lassen sich in zwei Typen unterteilen:

Queries: Abruf von Daten – z. B. Eventdetails oder Teilnehmerinformationen.

Mutations: Änderung oder Erstellung von Daten – z. B. das Generieren von Authentifizierungs-Tokens.

Neu in GraphQL? Eine gute Einführung bietet GraphQL lernen.

‍

Empfohlene Tools

Zum Erkunden und Testen der API eignen sich folgende Tools:

GraphQL IDEsTools wie GraphiQL Online ermöglichen eine einfache Erkundung der API direkt im Browser.

HTTP-ClientsAnfragen können auch mit Tools wie cURL oder Postman gesendet werden.

API-Dokumentation aufrufen

Die vollständige technische Dokumentation mit Anleitungen, Beispielen und Erklärungen für Entwickler:innen findest du im Oniva GraphQL API-Dokumentations-Repository auf GitHub:

Oniva GraphQL API Dokumentation