Schnittstellen (API): Schlüssel und Webhooks für Ihre Dienstleister
API-Schlüssel mit genau den nötigen Rechten anlegen und widerrufen und Webhooks einrichten, damit Ihre Dienstleister Reservierungen anbinden können.
Unter Einstellungen › Schnittstellen › Schnittstellen (API) geben Sie Dienstleistern, etwa Ihrer Webagentur oder einem Buchungsportal, Zugang zu Ihren Reservierungen. Sie brauchen dafür nichts zu programmieren: Sie legen einen Schlüssel an und geben ihn weiter. Die Seite gehört zum Bereich Reservierung; nutzen dürfen sie Admin und Chef.
API-Schlüssel anlegen
- Unter API-Schlüssel einen Name vergeben, der sagt, wer ihn nutzt (z. B. „Buchungsportal“ oder „Agentur“).
- Nur die Rechte ankreuzen, die der Dienstleister braucht:
- Reservierungen lesen (alle, mit Gastdaten)
- Reservierungen anlegen, ändern, stornieren
- Verfügbarkeit abfragen
- Veranstaltungen lesen
- Schlüssel anlegen.
- Der Schlüssel erscheint unter Ihr neuer API-Schlüssel genau einmal. Mit Kopieren übernehmen, sicher an den Dienstleister geben und dann Gespeichert, ausblenden.
Der Schlüssel wird nur jetzt angezeigt. Ist er verloren, legen Sie einen neuen an und widerrufen den alten.
Die Liste zeigt je Schlüssel Name, Anfang des Schlüssels, Rechte, wer ihn wann angelegt hat und wann er zuletzt benutzt wurde.
Schlüssel widerrufen
Arbeiten Sie nicht mehr mit dem Dienstleister zusammen oder ist der Schlüssel in falsche Hände geraten: Widerrufen klicken und bestätigen. Systeme, die ihn nutzen, verlieren sofort den Zugang. Der Eintrag bleibt mit „widerrufen am …“ sichtbar.
Webhooks: Gastro Control meldet sich bei Ihrem System
Mit einem Webhook schickt Gastro Control bei bestimmten Ereignissen eine Nachricht an eine Adresse Ihres Dienstleisters.
- Unter Webhooks die Empfangsadresse eintragen (sie muss mit https:// beginnen).
- Ereignisse wählen:
- Neue Reservierung (alle Wege: Widget, Team, Telefon, API)
- Reservierung geändert (Termin, Personen, Status, Gastdaten)
- Reservierung storniert
- Veranstaltung ausverkauft
- Optional Gastdaten mitsenden (Name, E-Mail, Telefon, Notiz). Nur ankreuzen, wenn der Empfänger diese Daten verarbeiten darf (Auftragsverarbeitung).
- Webhook anlegen. Das Signatur-Geheimnis dieses Webhooks erscheint einmal; geben Sie es dem Dienstleister, damit sein System die Nachrichten prüfen kann.
Je Webhook gibt es:
- Test senden: schickt eine Probenachricht.
- Neues Geheimnis: ersetzt das Signatur-Geheimnis; das alte gilt sofort nicht mehr.
- Löschen: entfernt den Webhook samt Protokoll.
- Ereignisse dieses Webhooks ändern und Speichern.
- Ein Protokoll der Zustellungen mit Zeit, Ereignis, Status, Versuche und Antwort. Schlägt eine Zustellung fehl, versucht Gastro Control es mehrfach in wachsenden Abständen; mit erneut senden stoßen Sie sie selbst an.
Anleitung für Ihren Dienstleister
Ganz unten steht die Anleitung für Entwickler mit Basisadresse, Beispielen und Fehlercodes. Schicken Sie Ihrem Dienstleister einfach den Link zu dieser Seite oder einen Ausdruck. Wichtig für Sie als Betrieb:
- Über die API angelegte Reservierungen prüfen dieselben Regeln wie Ihre Buchungsseite: Öffnungszeiten, angebotene Uhrzeiten, freier Tisch und Vorlauf.
- Der Dienstleister muss bestätigen, dass der Gast seiner Datenschutzerklärung zugestimmt hat.
- Kostenpflichtige Event-Buchungen liefern einen Zahlungslink für den Gast.
- Je Schlüssel sind 120 Lese- und 30 Schreibanfragen pro Minute möglich.
Häufige Fragen
- Mein Dienstleister bekommt die Meldung, der Schlüssel sei falsch oder widerrufen: Prüfen Sie, ob der Schlüssel noch aktiv ist und vollständig kopiert wurde. Sonst neuen Schlüssel anlegen.
- Der Dienstleister bekommt „Recht fehlt“: Dem Schlüssel fehlt das passende Recht. Rechte lassen sich nicht nachträglich ändern; legen Sie einen neuen Schlüssel an und widerrufen Sie den alten.
- Kann der Dienstleister Reservierungen ändern, die mein Team angelegt hat? Nein. Ändern und stornieren kann ein Schlüssel nur Reservierungen, die über die API angelegt wurden. Lesen kann er alle.
- Wozu brauche ich das Webhook-Geheimnis? Damit das empfangende System erkennt, dass die Nachricht wirklich von Gastro Control kommt.