Buchungswege

API-Zugang einrichten

Externe Systeme — eine Automatisierung, ein Quiz vor der Buchungsseite, ein eigener Dienst — sprechen mit BookIvy über gesicherte Adressen. Du erzeugst dafür Schlüssel; und in die andere Richtung legst du Verbindungen an, die BookIvy nach einem Kauf aufruft.

Wo im Backend
Einstellungen → Anbindungen → API-Keys und Einstellungen → Anbindungen → API-Verbindungen
Aufwand
ca. 5 Minuten je Schlüssel; die Anbindung selbst richtet meist ein Techniker ein
Vorher nötig
Das Modul „API-Keys“; für Verbindungen ein Produkt mit der Lieferart „API-Aufruf“.
Gebuchtes Modul
API-Keys

Was möchte ich erreichen?

Du möchtest, dass ein anderes System mit BookIvy arbeitet, ohne dass jemand Passwörter verteilt: Es soll freie Termine abfragen, Buchungen anlegen oder ein Ereignis melden. Jeder Zugang lässt sich einzeln abschalten, ohne die anderen zu stören.

Was bringt mir das?

  • Ein Schlüssel je Zweck. Chatbot, Automatisierung, Kalender-Feed und Datenübernahme haben getrennte Schlüssel. Den Chatbot kannst du abschalten, ohne die Automatisierungen mitzunehmen.
  • Nur gültige Aufrufe. Endpunkte antworten nur auf Aufrufe mit einem aktiven Schlüssel.
  • Regeln gelten immer. Öffnungszeiten, Abwesenheiten, Doppelbuchung und Tickets prüft BookIvy serverseitig — auch bei Aufrufen von außen.
  • In beide Richtungen. Eingehend per Schlüssel, ausgehend per Verbindung mit Signatur.

Wie funktioniert das — und wann brauche ich es?

API-Keys (eingehend)

SchlüsseltypWofür
n8n-Endpointsichert den Endpunkt, über den Automatisierungen Daten abrufen, zum Beispiel verfügbare Termine für den Chatbot.
ICS-Kalender-Exportsichert den abonnierbaren Kalender-Feed, den Personen freischalten — siehe Externe Kalender anbinden.
BookIvy-Chatbotnur bei der eigenen Chat-Fassung: der Zugang, über den der Chat Verfügbarkeiten liest und Buchungen anlegt. Ohne aktiven Schlüssel kann er weder Termine nennen noch buchen; es genügt einer.
Datenübernahmeerlaubt einer vorgeschalteten Seite, etwa einem Quiz oder Konfigurator, gesammelte Angaben an die Buchungsseite zu übergeben.
  • Ein Schlüssel wird nur ein einziges Mal vollständig angezeigt; danach ist er maskiert. Kopiere ihn sofort.
  • Jeden Schlüssel kannst du deaktivieren, reaktivieren und löschen.
  • Aufgerufen wird mit dem Header X-API-Key.

Die Endpunkte

AdresseAufgabe
endpoint/availability.phpliefert freie Termine einer Person für eine Leistung — als Tag oder Zeitraum, mit höchstens 500 Treffern. Es ist dieselbe Berechnung wie auf der Buchungsseite.
endpoint/booking.phplegt Buchungen an oder storniert sie (Tische, Räume, Leistungen). Mehrere Einträge in einem Aufruf sind möglich, freie werden gebucht und belegte einzeln gemeldet. Mit dry_run läuft alles außer dem Schreiben.
endpoint/prefill.phpnimmt Angaben eines vorgeschalteten Systems an und gibt ein Einmal-Token zurück, das in die Adresse der Buchungsseite gehört. Die Angaben selbst wandern nie durch die Adresse.

API-Verbindungen (ausgehend)

Ein Produkt mit der Lieferart „API-Aufruf“ wirkt nicht in BookIvy selbst: Nach der Zahlung ruft BookIvy eine Adresse auf, und das System dahinter stellt bereit, was gekauft wurde — eigenes System, n8n, Make oder ein anderer Dienst. Die Verbindung sagt, wohin der Aufruf geht und womit er sich ausweist; du legst sie einmal an und wählst sie am Produkt.

  • Name — nur für dich, unter diesem Namen wählst du die Verbindung am Produkt.
  • Adresse für die Auslieferung — dorthin geht nach jeder Zahlung ein POST mit JSON. Nur https, Standard-Port, öffentlich erreichbar; Weiterleitungen werden nicht verfolgt.
  • Adresse für die Vorab-Prüfung (optional) — die Verkaufsseite fragt damit vor der Zahlung beim Empfänger an: Er kann zusagen, Angaben vom Käufer verlangen oder den Kauf ablehnen.
  • Ausweis — eine Signatur über Zeitstempel und Inhalt (die sicherere Wahl, mit einem Geheimnis und optional einer Kennung) und/oder ein fester Wert als Kopfzeile mit Name und Wert. Mindestens einer ist nötig.
  • Testen schickt denselben Aufruf als Typ ping, ohne Kauf und ohne Käuferdaten. Antwortet der Empfänger mit 2xx, ist er erreichbar und nimmt den Ausweis an.

Das Format des Aufrufs — was ankommt und was der Empfänger antworten muss — steht in einer aufklappbaren Anleitung direkt in der Maske. Gib sie der Person weiter, die den Empfänger einrichtet. Ausgeliefert wird erst nach dem Zahlungseingang; bei einer Störung wiederholt BookIvy den Aufruf bis zu 24 Stunden.

Wer richtet die Workflows ein?

Laut Hinweis im Backend legt derzeit das Team hinter BookIvy die Workflows der n8n-Automatisierungen an und konfiguriert sie. Du erstellst die Schlüssel und teilst sie dort sicher mit.

Was muss ich einstellen und anklicken?

Weg A Einen Schlüssel erstellen

  1. Den Abschnitt öffnen

    Einstellungen → Anbindungen → API-Keys

  2. Den Typ wählen und erstellen

    Suche den passenden Typ und klicke auf „Neuen Key erstellen“. Eine Bezeichnung hilft später, ihn wiederzuerkennen.

  3. Den Schlüssel kopieren

    Klicke auf „Kopieren“ und bewahre ihn sicher auf. Er erscheint danach nur noch maskiert.

  4. Bei Bedarf sperren

    Mit „Deaktivieren“ stoppst du einen Schlüssel sofort, mit „Reaktivieren“ nimmst du ihn wieder in Betrieb. „Löschen“ entfernt ihn ganz.

Weg B Eine ausgehende Verbindung anlegen

  1. Den Abschnitt öffnen

    Einstellungen → Anbindungen → API-Verbindungen

  2. Eine neue Verbindung anlegen

    Trage unter „Neue Verbindung“ den Namen und die Adresse für die Auslieferung ein, wähle den Ausweis (Signatur mit Geheimnis oder fester Wert mit Name und Wert) und speichere.

  3. Testen

    Klicke auf „Testen“. Eine 2xx-Antwort des Empfängers zeigt, dass alles stimmt.

  4. Am Produkt wählen

    Wähle die Verbindung beim Produkt mit der Lieferart „API-Aufruf“, siehe Produkte im Shop verkaufen.

Was hängt damit zusammen?

Vorher

Wirkt auf

Danach sinnvoll

Gut zu wissen

Ich habe den Schlüssel nicht kopiert.

Ein vollständiger Schlüssel wird nur einmal gezeigt. Erstelle einen neuen und lösche den alten.

Der Chat nennt keine Termine mehr.

Prüfe, ob ein aktiver Schlüssel vom Typ „BookIvy-Chatbot“ existiert. Ohne ihn kann der Chat weder Termine nennen noch buchen.

Der Aufruf nach dem Kauf kommt nicht an.

Prüfe die Adresse: nur https, Standard-Port, öffentlich erreichbar, keine Weiterleitung. Klicke auf „Testen“ — der Stand je Kauf steht im Reiter „Verkäufe“ der Produkte.

Wird bei einer Erstattung der API-Aufruf zurückgenommen?

Nein. Was beim Empfänger schon geliefert wurde, nimmt BookIvy nicht zurück. Darauf weist die Rückfrage bei der Erstattung hin.