Überblick
Für Converia Classic stehen derzeit zwei API-Schnittstellen mit unterschiedlichem inhaltichem Fokus bereit. Die technische Dokumentation liegt als JSON- bzw. YAML-Datei (OpenAPI) vor und richtet sich an technische Dienstleistende, die eine Anbindung umsetzen. Converia API V2 deckt vor allem Inhalte aus dem Konferenzplaner sowie Beitrags-, Teilnehmenden-, Rechnungs- und Zahlungsdaten ab. Converia API V3 ist speziell für die Anbindung der Buchhaltung an Converia Classic konzipiert.
Voraussetzungen
Nutzung der API-Schnittstelle wurde beauftragt
Klärung, auf welche Daten und Inhalte aus Converia Classic über die API zugegriffen werden soll.
Prüfung, ob vor dem API-Zugriff zusätzliche Datenschutzvereinbarungen erforderlich sind. Über die APIs können Dienstleistende auf Teilnahmedaten, Adressen, gebuchte Optionen, Preise sowie auf Beitrags- und Programmdaten aus Converia Classic zugreifen.
Konfiguration / Vorgehen
Klären Sie zunächst den Einsatzzweck der API-Anbindung und welche Daten genau aus Converia ausgelesen werden sollen.
Nutzen Sie die Converia API V2, wenn Inhalte aus dem Konferenzplaner sowie Beitrags-, Teilnehmenden-, Rechnungs- oder Zahlungsdaten aus Converia Classic benötigt werden.
Nutzen Sie die Converia API V3, wenn die Anbindung für buchhaltungsnahe Daten und Prozesse in Converia Classic vorgesehen ist.
Prüfen Sie vor der Freigabe des API-Zugangs die datenschutzrechtlichen Anforderungen Ihres Projekts.
Stellen Sie den technischen Dienstleistenden die entsprechenden API-Zugangsinformationen und die aktuelle API-Beschreibung bereit.
Benötigte Daten für API-Zugriff
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 bzw. API-Username+API-Password)
technische API-Beschreibung, siehe weiterführende Artikel zu API V2 und API V3 unten
Anwendungsfälle
Bereitstellung von Programm- und Beitragsdaten aus Converia Classic für externe technische Integrationen über API V2.
Bereitstellung von Rechnungs-, Buchungs- und buchhaltungsnahen Daten aus Converia Classic für externe Systeme über API V3.
Hinweise
Beide APIs dienen ausschließlich dem Auslesen von Daten aus Converia Classic.
Über die APIs können keine Daten in Converia-Classic geschrieben oder verändert werden.
Die technische Beschreibung der Schnittstellen richtet sich ausdrücklich an technische Dienstleistende.
Die in dieser Kategorie beschriebenen APIs beziehen sich auf Converia Classic.
FAQs
Für welches Produkt gelten diese APIs?
Die in diesem Artikel beschriebenen Schnittstellen gelten für Converia Classic.
Welche API soll ich verwenden, wenn ich Daten aus dem Konferenzplan oder Beitragsdaten in externen Tools verwenden will?
Für diese Inhalte aus Converia Classic ist Converia API V2 vorgesehen.
Welche API ist für die Buchhaltungsanbindung vorgesehen?
Für Anbindungen einer externen Buchhaltungssoftware an Converia Classic ist Converia API V3 vorgesehen.
Welche API sollte ich verwenden, wenn ich ein externes System als Zugangskontrolle vor Ort einsetzen will?
In Converia Classic gibt es unterschiedliche Module für Zugangskontrollen, sowohl das Check-In-Modul im Backoffice, als auch eine eigene Self-Service-App. Wenn Sie ein externes Zugangssystem an Converia anbinden wollen, genügt meist schon die API V2.
Kann ich beide APIs gleichzeitig verwenden?
Ja, in komplexeren Szenarien kann es durchaus sinnvoll sein, Daten aus beiden APIs abzurufen.
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