Überblick
Die Converia Classic API V3 ist speziell für die Anbindung der Buchhaltung an Converia Classic konzipiert. Es gibt u.a. Endpunkte für Angebotskategorien, Angebotspakete, Buchungen, Konferenzen, Konferenzkategorien, Leistungsarten, Personen, Preisgruppen, Rechnungen, Rechnungsversionen, Sprachen und Zahlungsmethoden.
Voraussetzungen
Nutzung der API-Schnittstelle wurde beauftragt
Abstimmung mit den technischen Dienstleistenden, welche die Schnittstelle implementieren.
Prüfung der Datenschutzanforderungen vor Freigabe des Zugangs.
Konfiguration / Vorgehen
Prüfen Sie zusammen mit Ihrem technischen Dienstleister, ob die benötigten Daten für Ihre geplante API-Anbindung in API-V3 vorhanden sind. API V3 ist primär für die automatisierte Anbindung Ihres externen Buchhaltungssystems an Converia Classic 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 V3 Zugang zu umfassenden Personen-, Buchungs- und Rechnungsdaten aus Converia Classic.
Lassen Sie sich vom Converia-Team einen API-V3-Account anlegen.
Stellen Sie den technischen Dienstleistenden die API-Zugangsinformationen, sowie die aktuelle Schnittstellenbeschreibung der Converia Classic API V3 bereit (YAML-Datei im Anhang).
Benötigte Daten für Zugriff auf API V3
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-Username + API-Password)
aktuelle technische API-Beschreibung, siehe YAML-Datei im Anhang unten
Anwendungsfälle
Anbindung externer Buchhaltungs- oder Abrechnungssysteme an Converia Classic.
Verarbeitung von Buchungen, Rechnungen, Preisgruppen und Zahlungsmethoden aus Converia Classic in externen technischen Integrationen.
Hinweise
Dieser Artikel beschreibt ausschließlich die API V3 für Converia Classic.
FAQs
Für welches Produkt gilt die API V3 in diesem Artikel?
Dieser Artikel beschreibt die API V3 für Converia Classic.
Wofür ist die Converia Classic API V3 vorgesehen?
Die API V3 ist für die Anbindung der Buchhaltung in Converia Classic vorgesehen.
Welche Datenbereiche sind in der Dokumentation für V3 aufgeführt?
Angebotskategorien, Angebotspakete, Buchungen, Personen, Preisgruppen, Rechnungen, Rechnungsversionen und Zahlungsmethoden.
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 YAML-Dateien.
Anhänge
Hinweis: Die bereitgestellte YAML-Datei können Sie bspw. im Swagger Editor öffnen. Dort werden Endpunkte, Parameter und Datenmodelle strukturiert dargestellt.