API & Webhooks

Was die Salonnare-API und Webhooks sind, wofür du sie nutzt und wie du API-Schlüssel und Webhooks anlegst.

API & Webhooks

Mit der API und Webhooks von Salonnare verbindest du deinen Salon mit anderer Software: deinem Buchhaltungsprogramm, deiner eigenen Website, einem Newsletter-Dienst oder einem selbst gebauten Dashboard. Du musst kein Entwickler sein, um zu verstehen, was sie tun -- diese Seite erklärt es in Ruhe.

Noch nicht verfügbar

Diese Funktion ist in der App noch als Demnächst markiert: Du kannst derzeit keine API-Schlüssel oder Webhooks anlegen. Öffnest du Einstellungen > API & Webhooks, siehst du nur einen Hinweis, dass die Funktion kommt. Diese Seite beschreibt, wie es funktionieren wird, sobald die Funktion verfügbar ist.

Was ist eine API?

Eine API (Application Programming Interface) ist eine Vereinbarung, über die zwei Programme miteinander sprechen. Wo du in der App auf einen Knopf klickst, um einen Termin zu laden, kann ein anderes Programm dieselben Daten über die API abrufen -- automatisch und ohne manuelle Schritte.

Praktische Beispiele für einen Salon:

  • Deine Buchhaltungssoftware ruft jede Nacht automatisch deinen Umsatz ab.
  • Deine eigene Website zeigt deine Leistungen und Preise direkt aus Salonnare.
  • Ein Integrationspartner synchronisiert deine Kundenliste.

Der Zugriff auf die API läuft über einen API-Schlüssel: einen geheimen Code, der beweist, dass die Anfrage von dir kommt. Behandle ihn wie ein Passwort.

Einen API-Schlüssel anlegen

  1. Gehe zu Einstellungen -> API & Webhooks.
  2. Klicke im Reiter API-Schlüssel auf Neuer Schlüssel.
  3. Gib dem Schlüssel einen erkennbaren Namen (zum Beispiel "Buchhaltung") und wähle die Rechte: Nur lesen, Lesen + schreiben oder Vollzugriff. Derzeit kann ein API-Schlüssel unabhängig vom gewählten Rechtenniveau immer nur Daten abrufen; ein Schlüssel mit nur Leserechten kann ohnehin nie mehr als das.
  4. Kopiere den Schlüssel sofort und bewahre ihn sicher auf. Aus Sicherheitsgründen zeigt Salonnare den vollständigen Schlüssel nur einmal an.

Vermutest du, dass ein Schlüssel geleakt ist? Lösche ihn sofort -- jede Integration mit diesem Schlüssel wird umgehend gestoppt.

Was ist ein Webhook?

Ein Webhook ist die Umkehrung der API. Statt dass du Daten abrufst, sendet Salonnare automatisch eine Nachricht an eine Adresse (URL) von dir, sobald etwas passiert. Die andere Software muss nicht mehr ständig fragen "gibt es etwas Neues?" -- sie bekommt von selbst ein Signal.

Salonnare kann diese sechs Ereignisse senden:

  • booking.created -- eine Mitarbeiterin erstellt einen Termin in der App
  • booking.updated -- eine Mitarbeiterin ändert einen Termin in der App (auch eine Statusänderung auf abgeschlossen oder No-Show)
  • booking.cancelled -- eine Mitarbeiterin storniert einen Termin in der App
  • payment.received -- eine Mitarbeiterin schließt einen Kassenvorgang ab
  • client.created -- eine Mitarbeiterin legt einen Kunden in der App an
  • client.updated -- eine Mitarbeiterin ändert Kundendaten in der App
Nur was in der App passiert

Jedes Ereignis stammt aus einer Handlung in der App. Eine Online-Buchung über deine Buchungsseite oder Google, eine Kundin, die selbst storniert, eine umgewandelte Warteliste, eine Terminserie, eine Kur und eine Kundin, die sich selbst auf der Buchungsseite anlegt, senden (noch) keine Benachrichtigung. Sprich das mit deiner Integrationspartnerin ab: Sie kann die fehlenden Termine auffangen, indem sie die Terminliste regelmäßig abruft.

Einen Webhook einrichten

  1. Gehe zu Einstellungen -> API & Webhooks und öffne den Tab Webhooks.
  2. Klicke auf Neuer Webhook.
  3. Trage die URL ein, an die Salonnare die Benachrichtigungen sendet (die bekommst du von deinem Integrationspartner oder Entwickler).
  4. Wähle die Ereignisse, auf die du reagieren möchtest.
  5. Speichere. Danach kannst du die Versandprotokolle prüfen, um zu sehen, ob die Benachrichtigungen korrekt ankommen.

Das Geheimnis (Secret), mit dem Salonnare die Nachrichten signiert, wird angezeigt, sobald du den Webhook speicherst -- bewahre es sofort sicher auf, genau wie einen API-Schlüssel, denn Salonnare zeigt es nicht noch einmal an. Hast du es verloren, klicke beim Webhook auf das Aktualisieren-Symbol (Neues Geheimnis anfordern); du siehst dann einmalig ein neues Geheimnis. Das alte Geheimnis funktioniert ab diesem Moment nicht mehr, die Empfangsseite muss also ebenfalls aktualisiert werden.

Jede Webhook-Benachrichtigung trägt eine Signatur, mit der der Empfänger prüfen kann, dass die Nachricht wirklich von Salonnare stammt.

Sicher arbeiten

  • Teile API-Schlüssel niemals öffentlich (nicht in E-Mails, Screenshots oder online veröffentlichtem Code).
  • Gib einer Integration nur die Rechte, die sie wirklich braucht -- wähle nur lesen, wo möglich.
  • Lösche Schlüssel und Webhooks, die du nicht mehr nutzt.

Da Salonnare deine Daten in der EU verarbeitet und du selbst entscheidest, welche Integrationen Zugriff erhalten, behältst du die volle Kontrolle über deine Daten. Brauchst du Hilfe bei einer Integration? Melde dich gerne über die Support-Seite.

Bist du Entwickler und suchst die technischen Details (Authentifizierung, Endpunkte, Felder, Fehlercodes, Signaturprüfung)? Sieh dir die API Reference an -- diese Seite ist auf Englisch, weil sie sich an Entwickler richtet.

Verwandte Artikel

EinstellungenOnline-BuchungenBenachrichtigungen