API Service
Hardware-Integration

Hardware-Integration

Verbinden Sie physische Zutrittskontrollgeräte direkt mit TikFlow. Ihr Gerät scannt QR-Codes und kommuniziert per HTTP mit TikFlow – ohne eigene Software dazwischen.

💡 Funktionsprinzip: Ihr Zutrittskontrollgerät sendet den gescannten QR-Code per HTTP an TikFlow. TikFlow prüft und entwertet das Ticket und antwortet im Format Ihres Geräts – z.B. mit dem Befehl, das Drehkreuz zu öffnen.


Unterstützte Geräte

HerstellerModellStatus
TikFlowCloud B4 Network Access Controller✅ Unterstützt

📧 Ihr Gerät ist nicht aufgelistet? Wir entwickeln gerne weitere Adapter. Kontaktieren Sie uns über das Kontaktformular im Dashboard unter External API oder per E-Mail an support@tikflow.de.


Plug & Play – Vorkonfiguration durch TikFlow

Sie haben bereits einen Ticketshop bei TikFlow eingerichtet? Dann können wir Ihr Zutrittskontrollgerät vor der Auslieferung komplett vorkonfigurieren.

Vorteile:

  • Kein Konfigurationsaufwand – Gerät ist sofort einsatzbereit
  • Plug & Play – Aufstellen, Netzwerk anschließen, fertig
  • Minimaler Zeitaufwand – Einlass kann sofort starten
  • Keine technischen Kenntnisse nötig – TikFlow übernimmt die Einrichtung

So funktioniert's:

  1. Sie bestellen ein TikFlow-Gerät (z.B. Drehkreuz mit Cloud B4 Controller)
  2. Sie teilen uns Ihren Ticketshop bzw. die gewünschten Events mit
  3. Wir konfigurieren das Gerät vor Auslieferung auf Ihren Shop
  4. Das Gerät wird geliefert – Sie schließen es nur noch an Strom und Netzwerk an
  5. Fertig! Das Gerät validiert sofort Tickets aus Ihrem Ticketshop

💡 Ideal für: Veranstalter, die sich auf ihr Event konzentrieren möchten, ohne sich um technische Details kümmern zu müssen. Auch für Standorte mit mehreren Eingängen, bei denen alle Geräte identisch konfiguriert sein sollen.

Kontaktieren Sie uns für ein vorkonfiguriertes Gerät: support@tikflow.de


Ablauf

🎫 Besucher
scannt QR-Code

📡 Controller
sendet HTTP POST

☁️ TikFlow
validiert Ticket

✅ Zutritt
Drehkreuz öffnet

  1. Besucher hält den QR-Code vor den Scanner am Eingang
  2. Controller liest den QR-Code und sendet ihn per HTTPS an TikFlow
  3. TikFlow validiert das Ticket und entwertet eine Nutzung
  4. Controller erhält die Antwort – bei Erfolg öffnet das Drehkreuz, bei Ablehnung erscheint eine Meldung auf dem Display

Einrichtung

Schritt 1: API-Key erstellen

  1. Öffnen Sie das TikFlow Dashboard (opens in a new tab)External API
  2. Wählen Sie den Integrationstyp „TikFlow Hardware"
  3. Vergeben Sie einen Namen (z.B. „Drehkreuz Eingang")
  4. Optional: Event-Scope festlegen
  5. Nach dem Erstellen erhalten Sie:
    • Den API-Key
    • Die fertige Card URL (zum Kopieren)
    • Die fertige Heart URL (zum Kopieren)

⚠️ Speichern Sie die URLs sofort – der API-Key wird nur einmal angezeigt!

Schritt 2: Gerät konfigurieren

Tragen Sie die Verbindungsdaten in die Konfigurationsoberfläche Ihres Geräts ein. Die genauen Einstellungen variieren je nach Gerätemodell – siehe gerätespezifische Anleitung unten.

Schritt 3: Testen

Scannen Sie einen Test-QR-Code. Im TikFlow Dashboard unter Scan-Log können Sie den Scan in Echtzeit nachverfolgen.


Cloud B4 – Konfigurationsanleitung

Der TikFlow Cloud B4 Network Access Controller wird über das Web-Interface des Geräts konfiguriert.

Netzwerkeinstellungen

Stellen Sie sicher, dass der Controller mit dem Internet verbunden ist (LAN-Kabel). Öffnen Sie die IP-Adresse des Geräts im Browser.

HTTP-Protokoll konfigurieren

Navigieren Sie in der Gerätekonfiguration zu den HTTP-Einstellungen und tragen Sie folgende Werte ein:

EinstellungWert
Server Addressscan.tikflow.de
Port443
Domain Name✅ aktiviert
HTTP✅ aktiviert
TLSTLS (only client)
Card URL/scan/hw/consume?key=IHR_API_KEY
Heart URL/scan/hw/heartbeat?key=IHR_API_KEY
Wait server response time30
Secret Key(leer lassen)

💡 Tipp: Die Card URL und Heart URL werden beim Erstellen des API-Keys im Dashboard angezeigt und können direkt kopiert werden.

QR-Scanner-Einstellungen

EinstellungWert
Reader-AnschlussRS232 A oder RS232 B (je nach Verkabelung)
CodierungBase64

ℹ️ Der B4 sendet den QR-Code-Inhalt Base64-kodiert an TikFlow. Die Dekodierung erfolgt serverseitig automatisch.

Wait server response time

Der Wert 30 entspricht 3 Sekunden Timeout (Einheit: 100ms). Das gibt TikFlow ausreichend Zeit für die Verarbeitung, auch bei einem Kaltstart des Servers.

WertTimeout
151,5 Sekunden (Standard, kann zu knapp sein)
303 Sekunden (empfohlen)
505 Sekunden (für langsame Netzwerke)

Display-Anzeige

Bei unterstützten Geräten zeigt TikFlow Informationen auf dem Gerätedisplay an:

Bei gültigem Ticket:

ZeileInhaltBeispiel
NameVorname + Initiale des NachnamensMax M.
NoteStatus mit NutzungszählerTicket gültig (3/10)

Bei ungültigem Ticket:

ZeileInhaltBeispiel
NoteAblehnungsgrundTicket erschöpft

ℹ️ Die Displaytexte werden automatisch auf die maximale Zeichenlänge des Geräts gekürzt (B4: Name 16 Bytes, Note 32 Bytes).


Scan-Log

Scans von Hardware-Geräten werden im TikFlow Dashboard unter Scan-Log protokolliert. Hardware-Scans sind an der Geräte-ID erkennbar:

FeldFormatBeispiel
Geräthw_<Seriennummer>hw_897132

So können Sie jederzeit nachvollziehen, welches Gerät welchen Scan ausgeführt hat.


Fehlerbehebung

Gerät zeigt „Server Error" oder reagiert nicht

PrüfpunktLösung
InternetverbindungLAN-Kabel prüfen, Ping auf scan.tikflow.de testen
Server AddressMuss exakt scan.tikflow.de sein
PortMuss 443 sein
TLSMuss TLS (only client) sein
Card URLBeginnt mit /scan/hw/consume?key=
API-KeyIm Dashboard prüfen, ob der Key aktiv ist

Drehkreuz öffnet nicht, obwohl Ticket gültig

PrüfpunktLösung
Wait TimeAuf mindestens 30 erhöhen (3 Sekunden)
Relais-VerkabelungPrüfen, ob das Drehkreuz am richtigen Relais hängt
Event-ScopePrüfen, ob der API-Key Zugriff auf das Event hat

Heartbeat schlägt fehl

Der Controller sendet regelmäßig Heartbeats an die Heart URL. Wenn diese fehlschlagen:

PrüfpunktLösung
Heart URLMuss /scan/hw/heartbeat?key=IHR_KEY sein
DNSController muss scan.tikflow.de auflösen können
FirewallAusgehende HTTPS-Verbindungen (Port 443) müssen erlaubt sein

Weiteres Gerät anbinden?

TikFlow nutzt ein Adapter-System, das verschiedene Hardware-Formate unterstützt. Wenn Ihr Zutrittskontrollgerät HTTP-Requests senden kann, können wir es wahrscheinlich anbinden.

Kontaktieren Sie uns mit folgenden Informationen:

  • Hersteller und Modell
  • Technische Dokumentation / SDK (falls vorhanden)
  • Gewünschter Standort und Einsatzzweck

📧 support@tikflow.de oder über das Kontaktformular im Dashboard unter External API.