API-Schlüssel
Öffnen: API-Schlüssel im linken Menü. Verfügbar für Restaurantadministratoren.
Ein API-Schlüssel identifiziert ein Integrationsgerät der Kasse. Er ist kein Passkey für die persönliche Anmeldung.
Schlüssel erzeugen
- Wählen Sie API-Schlüssel hinzufügen.
- Wählen Sie den Standort der Integration.
- Wählen Sie API-Schlüssel generieren.
- Klicken Sie beim neuen Eintrag auf die angezeigte Kennung, um sie zu kopieren.
- Hinterlegen Sie Schlüssel und Anwendungsadresse in der Integration.
Behandeln Sie die Kennung als Zugangsdaten. Zeigen Sie sie nicht in Screenshots oder öffentlichen Supportnachrichten. Der Erstellungsdialog bietet keine nachträgliche Standortzuordnung; erzeugen Sie den Schlüssel für den richtigen Standort.
Verbindung verstehen
| Anzeige | Bedeutung |
|---|---|
| Verbundene Clients | Aktive Verbindungen zum Ereignisstrom dieses Schlüssels. |
| SSE | Mindestens eine Dienstverbindung ist offen. |
| Zeit seit letztem Aufruf | Zeit seit der zuletzt gemeldeten Kassenabfrage. |
| Achtung | Keine aktuelle Abfrage und keine angezeigte SSE-Verbindung. |
| Strich | Kein Zeitpunkt der letzten Abfrage verfügbar. |
Eine Verbindung bestätigt keinen Auftragseingang. Prüfen Sie Bestellungen unter Tische und Befehle unter Nachrichten.
Schlüssel entfernen
Beenden Sie zuerst die Dienstverbindungen der Integration. Solange Clients verbunden sind, ist Löschen gesperrt. Entfernen Sie nur nicht mehr benötigte Schlüssel; die Integration benötigt anschließend weiterhin gültige Zugangsdaten.
Der aktuelle Erstellungsdialog hat kein Feld zum Wiederherstellen einer früheren Kennung. Ein gelöschter Schlüssel lässt sich dort nicht wiederherstellen.
Informationen zu Anfrage-Headern und Protokoll finden Sie unter API-Authentifizierung.
Integrationsschlüssel ersetzen
- Erzeugen Sie einen neuen Schlüssel für den vorgesehenen Standort.
- Stimmen Sie den Wechsel mit dem Integrationsbetreiber ab und hinterlegen Sie den neuen Schlüssel im Client.
- Prüfen Sie die Verbindungsanzeige des neuen Schlüssels und einen abgestimmten Testvorgang an der Kasse.
- Beenden Sie Verbindungen mit dem alten Schlüssel. Löschen Sie ihn, sobald die Anzahl verbundener Clients null ist.
Koordinieren Sie den Wechsel, damit nicht zwei Clients dieselben Vorgänge verarbeiten. Prüfen Sie bei Authentifizierungsfehlern zuerst Anwendungsadresse und hinterlegten Schlüssel, bevor Sie weitere Schlüssel erzeugen.