Zum Hauptinhalt springen

API-Zugang – Übersicht

Dieser Artikel beschreibt, welche APIs für Converia Classic verfügbar sind, wofür sie eingesetzt werden und welche aktuelle API-Beschreibung je Schnittstelle bereitsteht.

Verfasst von André Tripp
Vor über einem Monat aktualisiert

Überblick

Für Converia Classic stehen derzeit zwei API-Schnittstellen mit unterschiedlichem fachlichem Fokus bereit. Die technische Dokumentation liegt als Swagger- bzw. OpenAPI-Datei 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 in Converia Classic konzipiert.


Voraussetzungen

  • Zugriff auf Ihre Daten in Converia Classic und Abstimmung mit den technischen Dienstleistenden, die die Schnittstelle anbinden.

  • 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

  1. Klären Sie zunächst den fachlichen Einsatzzweck der Anbindung in Converia Classic.

  2. Wählen Sie Converia API V2, wenn Inhalte aus dem Konferenzplaner sowie Beitrags-, Teilnehmenden-, Rechnungs- oder Zahlungsdaten aus Converia Classic benötigt werden.

  3. Wählen Sie Converia API V3, wenn die Anbindung für buchhaltungsnahe Daten und Prozesse in Converia Classic vorgesehen ist.

  4. Stellen Sie den technischen Dienstleistenden die aktuelle API-Beschreibung der gewählten Schnittstelle bereit.

  5. Prüfen Sie vor der Freigabe des API-Zugangs die datenschutzrechtlichen Anforderungen Ihres Projekts.


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

  • Die technische Dokumentation 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 für den Konferenzplaner und Beitragsdaten verwenden?

Für diese Inhalte in Converia Classic ist Converia API V2 vorgesehen.

Welche API ist für die Buchhaltungsanbindung vorgesehen?

Für buchhaltungsnahe Anbindungen in Converia Classic ist Converia API V3 vorgesehen.


Weiterführende Artikel

Hat dies deine Frage beantwortet?