SeminarDesk bietet eine nicht-öffentliche Private API (application programming interface, Software-Schnittstelle) zur Integration des eigenen SeminarDesk mit geeigneter anderer Software, bspw. einer Rechnungssoftware oder einem Newsletter-Tool.
Die Private API ist noch im Beta-Stadium und Wachstum; wir freuen uns auf Feedback zu praktischen Tests per Mail an support@seminardesk.de.
Neben der Private API bietet SeminarDesk eine öffentliche API für Veranstaltungen, Termine und Buchungen mit Funktionen zum Lesen der Details von Veranstaltungen, Veranstaltungsterminen, Referent*innen und Preisen sowie zum Erstellen von Buchungen.
Einrichtung der Zugriffs-Schlüssel
Die Funktionen der Private API stehen abhängig vom gebuchten SeminarDesk-Paket als Teil dedizierter „Services settings“ zur Verfügung. Zur Aktivierung dieser Einstellungen bitte unseren Support per Mail an support@seminardesk.de kontaktieren.
Darauf hin können wir unter Verwaltung – Setup – Webhooks und Schnittstellen im Abschnitt „Private API Schlüssel“ einen oder mehrere „API Keys“ genannte Schlüssel anlegen, die den Zugriff auf die eigenen SeminarDesk-Daten über die Private API kontrollieren.
Beim Hinzufügen eines neuen Schlüssels legen wir lediglich dessen Namen und optional eine Beschreibung fest. Danach können wir diesen Schlüssel Bearbeiten und differenzierte Berechtigungen erteilen.
Die externe Software, der wir unseren privaten API-Schlüssel geben, kann mit diesem Schlüssel ausschließlich im Rahmen dieser Berechtigungen auf unsere Daten in SeminarDesk zugreifen. So benötigt beispielsweise ein zu integrierendes Newsletter-Tool Lese- und Schreibrechte für andere Daten als eine ebenfalls zu integrierende Rechnungssoftware. Wir erstellen deshalb für jedes der zu integrierenden Systeme einen separaten Schlüssel mit nur den jeweils benötigten Berechtigungen.
Die festgelegten Berechtigungen eines API-Schlüssels können wir in der Übersicht durch Klick auf das Auge-Symbol in Spalte „Berechtigungen“ ansehen.
Nutzung der Private API
Zum Zugriff über die SeminarDesk Private API geben wir der zu integrierenden externen Software ihren Zugriffs-Schlüssel. Das ist eine Zeichenkette, die in der Übersicht in Spalte „Berechtigungen“ steht. Die Zeichenkette ist standardmäßig verschleiert; wir können sie durch Klick auf das dortige Auge-Symbol sichtbar machen und abschreiben oder durch Klick auf das Kopieren-Symbol ganz rechts bequem in die Zwischenablage kopieren und an anderer Stelle einfügen.
Die Möglichkeiten der Integration und das Vorgehen hängen dabei von der zu integrierenden Software ab. Häufig wird die Private API in Verbindung mit Webhooks-Benachrichtigungen verwendet. Verbreitet ist die Verknüpfung der APIs mehrerer Anbieter über ein Prozess-Automatisierungs-Werkzeug, bspw. Make.
Wenn bei der Integration von SeminarDesk mit einem externen System über die Private API eine regelmäßige Synchronisation stattfinden soll, müssen die Entitäten in beiden Systemen aufeinander verweisen. Bspw. soll bei der Änderung der Adresse eines Personenprofils in SeminarDesk die Adresse derselben Person auch in einer verknüpften Software zur Rechnungserstellung aktualisiert werden.
Zu diesem Zweck können bei der Erstellung einer solchen Entität (Veranstaltung, Veranstaltungstermin, Profil, Buchung, Rechnung) bestimmte Angaben als Externe Referenzen angegeben werden. Sie sind dann in entsprechenden Webhooks-Benachrichtigungen von SeminarDesk enthalten und lassen sich zum Filtern von Abfragen über die Private API nutzen.
Die Dokumentation der Private API kann hier eingesehen werden.
Gern sind wir bei der Einrichtung bzw. Anpassung individueller Integrationen behilflich. Dazu bitte unseren Support per Mail an support@seminardesk.de kontaktieren.