Überblick
Die Converia Classic API V2 ist für umfangreiche Inhalte aus dem Konferenzplaner sowie für Beitragsinformationen und rudimentäre Teilnehmenden- und Rechnungsdaten vorgesehen. In der Dokumentation werden dafür mehrere fachliche Bereiche und Objektgruppen aufgeführt, darunter Teilnehmende, Rechnungen, Zahlungen, Themen sowie verschiedene Planungsobjekte des Konferenzplans.
Voraussetzungen
Nutzung der API-Schnittstelle wurde beauftragt
Abstimmung mit den technischen Dienstleistenden, welche die Schnittstelle implementieren
Prüfung der Datenschutzanforderungen vor Freigabe des API-Zugangs
Konfiguration / Vorgehen
Prüfen Sie zusammen mit Ihrem technischen Dienstleister, ob die benötigten Daten für Ihre geplante API-Anbindung in API-V2 vorhanden sind. Converia Classic API V2 ist primär für das Auslesen von Programminhalten, Beitragsdaten und einfachen Daten von Teilnehmenden durch externe Systeme konzipiert.
Prüfen Sie vor der Übergabe der API-Zugangsdaten an externe Dienstleister, ob zusätzliche vertragliche Regelungen zur Datenverabeitung erforderlich sind. Die externen Dienstleister erhalten über die API V2 neben den Programminhalten Zugang zu umfassenden Beitrags-, Personen-, Buchungs- und Rechnungsdaten aus Converia Classic.
Lassen Sie sich vom Converia-Team einen API-V2-Account anlegen.
Stellen Sie den technischen Dienstleistenden die entsprechenden API-Zugangsinformationen und die aktuelle API-Beschreibung bereit, siehe Anhang unten.
Benötigte Daten für Zugriff auf API V2
URL der Converia-Installation (bspw.
https://express.converia.de, ohne weitere Pfadangaben)Interne ID der Veranstaltung (siehe Konfiguration → Grundeinstellungen → Konfiguration → Generelle Einstellungen → Interne ID). Die internen IDs der Veranstaltungen können Dienstleistende auch über die APIs ermitteln.
API-Zugangsdaten (API-Token)
aktuelle technische API-Beschreibung, siehe JSON-Datei im Anhang unten
Anwendungsfälle
Allgemein: Veranstaltungsdaten aus Converia Classic werden in externen Anwendungen benötigt, bspw. Programminhalte, Beitragsdaten oder einfache Daten zu Teilnehmenden, Rechnungen und Zahlungen.
Beispiel Programm-App oder Webseite: Auslesen von Programminhalten aus Converia Classic durch externe Systeme, bspw. Sitzungen & Beiträge mit Raum und Uhrzeit, Beitragsdaten, Chairs, Vortragende & Autoren.
Beispiel Check-In: Überprüfung der Zugangsberechtigung von Teilnehmenden in externen Systemen
Hinweise
Dieser Artikel beschreibt ausschließlich die API V2 für Converia Classic.
FAQs
Für welche Daten ist die Converia Classic API V2 geeignet?
Inhalte aus dem Konferenzplaner, Beitragsinformationen sowie rudimentäre Teilnehmenden- und Rechnungsdaten.
Wie lautet die URL der Converia-Installation?
Die URL Ihrer Converia-Installation finden Sie in der Adresszeile des Browsers, wenn Sie Converia aufrufen, z.B. https://express.converia.de. Achten Sie beim Kopieren der URL darauf, dass Sie keine weiteren Pfadangaben mitkopieren, wie z.B. .../admin/core/dashboard.
Wo ermittle ich die interne ID einer Veranstaltung in Converia Classic?
Konfiguration → Grundeinstellungen → Konfiguration → Generelle Einstellungen → Interne ID
Externe Verlinkungen
Swagger Editor – Zum Öffnen der bereitgestellten JSON-Dateien.
Anhänge
Hinweis: Die bereitgestellte JSON-Datei können Sie bspw. im Swagger Editor öffnen. Dort werden Endpunkte, Parameter und Datenmodelle strukturiert dargestellt.