Zum Inhalt springen

Funktionen · Plattform & Betrieb

Integrationen & API

Hier ist beschrieben, wie DiKAS mit anderen Programmen spricht. Nach aussen gibt es zwei Wege: die moderne Schnittstelle unter /api/v1, die mit einem Anmelde-Token arbeitet und in einer durchsuchbaren Online-Referenz dokumentiert ist, und eine ältere Schnittstelle unter /rest/, die noch mit festen Zugangsschlüsseln arbeitet und vor allem für bestehende Fremdsysteme da ist (Warenwirtschaft, Kartenautomaten, Telefonanlage, Online-Bestellportale). Dazu kommen fertige Anbindungen, die der Betrieb selbst einschalten kann: Bestellungen per WhatsApp, Artikelpflege in einer Google-Tabelle, Adressvervollständigung beim Anlegen von Kunden und mehrere KI-Hilfsfunktionen wie „Speisekarte abfotografieren und Artikel daraus erzeugen". Anbindungen an Lieferportale, Banken, Kassensicherungs- und Zahlungsanbieter sind bewusst nicht hier, sondern in den jeweiligen Fachbereichen.

36 geprüfte Funktionen Funktionsstand 29.08.2026
API-Schlüsselverwaltung in DiKAS

Schnittstellenzugänge kontrolliert verwalten.

Echte Oberfläche

Integrationen & API in DiKAS

Keine Stockmotive: Die Aufnahmen stammen aus den reproduzierbaren DiKAS-Demos und zeigen die jeweilige Funktion im Produkt.

KI-Dienste in den DiKAS-Einstellungen
KI-Dienste und Importfunktionen konfigurieren.

Vollständiger Überblick

Was DiKAS in diesem Bereich kann

Alle folgenden Punkte stammen aus dem gegen den Programmcode geprüften Funktionskatalog.

Öffentliche v1-API

Rund 565 Endpunkte unter /api/v1, Anmeldung per JWT-Bearer-Token, einheitliche Antwort-Hülle {success, data}

Anleitung öffnen

API-Referenz (Swagger/OpenAPI)

Durchsuchbare Endpunkt-Referenz unter /swagger, inkl. „Authorize"-Knopf zum Ausprobieren

Anleitung öffnen

Sichtbarkeits-Steuerung der Referenz

Entscheidet, welche Controller als „öffentliche Entwickler-API" gelten und welche verborgen bleiben

Wiederholsichere Aufrufe

Idempotency-Key-Kopfzeile: derselbe Schlüssel innerhalb einer Stunde liefert das erste Ergebnis erneut, statt doppelt zu buchen

Anleitung öffnen

Alt-Schnittstelle /rest/

Kompatibilitäts-Ebene für bestehende Fremdsysteme, PascalCase-JSON, Schlüssel im URL-Pfad; historische Request-Bodies mit einfachen statt doppelten JSON-Quotes werden vor der Modellbindung normalisiert

Anleitung öffnen

API-Schlüssel verwalten

Schlüssel anlegen, umbenennen, löschen, neuen Schlüssel erzeugen; je Schlüssel genau eine Zugriffsart

Schlüsselprüfung Alt-API

Zieht den Schlüssel aus dem {key}-Pfadsegment und prüft ihn gegen die erlaubten Zugriffsarten

Artikel-Import aus der Warenwirtschaft

POST /rest/erp/import/{key} — Artikel und Warengruppen aus einem ERP übernehmen, wahlweise im Ersetzen-Modus; der Alt-Endpunkt toleriert fehlende/kaputte optionale Gruppendaten und historisches Pseudo-JSON mit einfachen Quotes

Buchungsschnittstelle (Bar/Karte)

Artikel per PLU einzeln oder als Stapel buchen, Kartenkonto abfragen und Preis abfragen. POST /rest/cp/addcard/{key} legt offene Bons an; ?new=1 erzeugt eine unbekannte PLU genau einmal in der Hauptgruppe. Die Kasse springt bei einer Arbeitsplatz-Buchung aus einer Fremdseite nach Direktverkauf und nach vollständiger Zahlung einmalig zur selben Fremdseite zurück; bei Restbons oder manuellem Verlassen bleibt bzw. verfällt das Ziel. Legt der Kunde vor dem Kassieren eine freie NFC-Karte auf, legt die Kasse daraus einen Bonuskarten-Kunden an und nimmt ihn als Kunden der Zahlung mit. Optional fragt sie in beiden Reihenfolgen „Karte, dann Kunde" und „Kunde, dann Karte", ob die freie Karte zum gewählten Kunden verschoben werden soll. Eine WebHookUrl wird nach erfolgreichem Kassieren mit dem Legacy-Beleg und beim Storno eines unbezahlten Bons mit Comment=Storno/negativer Menge aufgerufen. addcard/{key}/{cardId} kassiert dagegen unmittelbar vom Kartenkonto.

Kunden-Schnittstelle

Kunden suchen; bis zu 500 Änderungen strikt nach einem Cursor abholen (GET /rest/extern/customer/{key}/changes/{date}, Classic-Formate yyyyMMdd, yyyyMMddHHmm, yyyyMMddHHmmss in lokaler Serverzeit); Karten-ID und Gesamtsaldo aus Bar-/Bonusguthaben lesen; deaktivierte Kunden kommen als IsDeleted=true; Guthaben prüfen; Umsatzliste

Kundenguthaben-Schnittstelle

Guthaben aufladen/abbuchen, reservieren, offenen Betrag lesen, einlösen und Buchungsverlauf nach Zeitraum abrufen; der Verlauf akzeptiert die Classic-Datumsformate yyyyMMdd, yyyyMMddHHmm, yyyyMMddHHmmss in lokaler Serverzeit. Seit 20.08.2026 Classic-kompatibel: allocation liefert die AllocationId auch in Message, redeem nimmt Betrag ODER AllocationId, cancel/redeem finden eine offene Reservierung auch über die als Comment mitgeschickte Fremd-Referenz, und changelist liefert SettledDate/IsOpenAllocation

Gutschein-Schnittstelle

Gutschein anlegen, abfragen, einlösen

Kartenterminal / Tabletop

Kartendaten, Transaktionen, Gastinfo und Kartenfreigabe für Automaten und Schankanlagen

Online-Bestell-Schnittstelle

Artikelliste, Tische, Drucker lesen; Bestellung anlegen, öffnen, bezahlen; Nachricht an einen Tisch

Rechnungs-/Belegabruf

Belege nach Bon-Nummernbereich oder Datumsbereich abholen

Fritz!Box-Telefonbuch & vCard

phonebook.xml für die Fritz!Box und all.vcf als Kontaktdatei aus dem Kundenstamm

FRITZ!Box-Anruferkennung (Anrufmonitor)

Der Server verbindet sich mit dem Anrufmonitor der Box (<host>:1012, an der Box mit #965 einschalten), liest RING/DISCONNECT, ordnet den Anrufer per Rufnummer dem Kunden zu (PhoneNumberNormalizer, dieselbe Regel wie die Kundensuche) und meldet IncomingCall { phoneNumber, matchedCustomerId?, matchedCustomerName? } per SignalR an die Kassen; das Anruf-Popup führt mit „Annehmen" in den Telefon-Modus (05). Einstellung im Backoffice (Hardware → Anrufer-Erkennung: Host, Ein/Aus, Verbindungstest, Status verbunden/getrennt) oder — für die Appliance — Telephony:FritzBox:Host in der Einstellungsdatei. Wiederverbindung mit Backoff 5–60 s; nur Nummer und Zeitpunkt im Speicher, nichts wird persistiert; nur lokal/Einzelmandant

GloriaFood-Bestelleingang

Nimmt Bestellungen des Portals GloriaFood entgegen und legt Lieferaufträge an

WhatsApp-Bestellungen (Bridge-Seite)

Eingehende Nachricht entgegennehmen, Antwort zurückgeben, ausgehende Nachrichten als Postausgang bereitstellen und quittieren

WhatsApp koppeln (Admin)

Kopplungs-Sitzung starten und QR-Code im Dialog anzeigen, bis „Verbunden" gemeldet wird

WhatsApp-Bestellung verstehen

KI ordnet den freien Text der Online-Karte zu, fragt bei Unklarheit nach und legt sonst eine normale Online-Bestellung an

Artikelpflege per Google-Tabelle

Kunde verknüpft im Portal ein Google-Sheet; Artikel und Warengruppen werden in beide Richtungen abgeglichen

Änderungsmeldung von Google Drive

Google meldet „Datei geändert"; der Eintrag wird nur als schmutzig markiert, der Abgleich läuft entprellt im Hintergrund

Sheet-Abgleich im Hintergrund

Entprellt (10 s Ruhe, spätestens 60 s), erneuert Google-Kanäle, stündlicher Vollabgleich als Sicherheitsnetz

Adressvervollständigung

Adressvorschläge während der Eingabe, Adresse zu Koordinaten auflösen, Ortsdetails abrufen

Anleitung öffnen

Google-Unternehmensprofil: Buchungslink

GET /api/v1/config/order-base-url liefert shopUrl und reservationUrl als kanonische Links für Subdomain- und Pfadmodus; die Betriebs-Einstellungen erklären das Hinterlegen des Reservierungslinks bei Google

KI: Speisekarte einlesen

Foto oder PDF einer Karte wird zu Artikeln mit Name, Preis, Gruppe und Steuersatz-Vorschlag

Anleitung öffnen

KI: Spaltenzuordnung

Schlägt zu den Spaltenüberschriften einer Importdatei die passenden DiKAS-Felder vor

Anleitung öffnen

KI: Allergene & Beschreibung

Schlägt zu einem Artikelnamen Allergene bzw. einen Beschreibungstext vor

Anleitung öffnen

KI: Beleg auslesen

Aus dem Foto eines Eingangsbelegs Gesamtbetrag, Steueraufteilung, Datum, Aussteller, Rechnungsnummer, Positionen und Kategorie-Vorschlag ziehen

KI: Tagesgericht vorschlagen

Aus Restposten und dem eigenen Artikelstamm zwei Gerichtsideen bauen (Task-Alias text-cheap); Kalkulation und Übernahme liegen im Artikelbereich

KI-Zugang ohne eigenen Schlüssel

Standardweg über den DiKAS-Dienst ai.dikas.de; der Betrieb braucht keinen eigenen Anbieter-Schlüssel

Eigener KI-Anbieter

Betrieb hinterlegt stattdessen Anbieter, Adresse, Modell und Schlüssel selbst (z. B. selbst gehostetes Modell)

Mandanten-Token für den KI-Dienst

Kurzlebiges signiertes Token je Mandant statt eines Anbieter-Schlüssels im Backend

Öffentlicher Schlüssel (JWKS)

/.well-known/jwks.json — damit der KI-Dienst die Token-Signatur prüfen kann

Plugin-/Modul-System

Fachmodule liegen als eigene Bausteine vor und werden beim Start geladen; ein Deployment kann Module gezielt aus- oder einschalten

Anleitung öffnen

Oft gesucht

Begriffe rund um Integrationen & API

APISchnittstelleRESTSwaggerOpenAPIEndpunktAPI-SchlüsselAPI-KeyTokenJWTBearerWebhookFremdsystemanbindenIntegrationLegacyrestWhatsApp