MQTT- und API-Integration

MQTT und API für die Maschinensteuerung

Leitfaden für den Pfad zwischen Backend, QuLink-Controller und Vending- oder Self-Service-Maschine. Endpunkte, Topics, Authentifizierung und Payloads werden pro Firmware bestätigt.

HTTPS APIMQTT topicsIdempotent commandsEvent callbacks
QuLink MQTT and API controller board for vending machines

Transport choice

HTTPS or MQTT?

Both can exist in one project. The choice depends on whether you need a response now or a stream of events.

Use caseHTTPS APIMQTT
Backend sends a commandRequest / responsePublish to command topic
Backend receives eventsWebhook or pollingSubscribe to event topic
Best fitServer-triggered actionsReal-time status and telemetry
Failure handlingHTTP status + retryQoS + reconnect + idempotency

The exact transport available on a machine depends on the controller, firmware, and network path.

Projektpassung

Für Teams, die eine Maschine an ihr Backend anbinden

Bedarfsignale

  • Your backend or app needs to trigger a vend, relay, pulse, unlock, or timed session.
  • Your platform uses HTTPS, webhooks, or MQTT and wants the machine-side contract in one place.
  • You need event identity, retries, and offline behavior defined before a sample.
  • You want to keep your own payment provider, schema, and dashboard.

Was Sie senden sollten

  • Fotos der Maschine oder aktuellen Platine
  • Hinweise zu Schnittstelle oder Verkabelung
  • Zielaktion nach API oder Zahlung
  • Ob Daten-Upload benötigt wird

Nicht geeignet, wenn

  • You need payment acquiring, settlement, or wallet balance.
  • The machine has no controllable interface or usable event source.
  • You need a fixed API contract before the controller and firmware are confirmed.

Integrationsmodell

Ein Vertrag, zwei Transporte

HTTPS für Befehle und Antworten, MQTT für Echtzeit-Events. Geräteidentität, Topics, Authentifizierung und QoS werden pro Projekt bestätigt.

API transport
HTTPS REST; JSON request and response
MQTT transport
MQTT 3.1.1 over TLS 1.2; QoS 1; keepalive 60s
Device identity
Project-issued device_id
Command reference
reference_id is used for idempotency
Event identity
event_id, occurred_at, device_id, result
Authentication
HTTPS Bearer token; optional HMAC-SHA256
Error model
unauthorized, device_offline, timeout, invalid_command, machine_fault

Ablauf

Vom Maschinenfoto zum getesteten Ablauf.

Confirm the machine interface

Send the controller label, wiring photos, and the action the machine must perform.

Define the command contract

Confirm command names, slot or channel mapping, timeout, and result fields.

Connect the transport

Issue device identity, token, topic prefix, TLS mode, and QoS for the project.

Test one machine

Validate command, machine action, event identity, retry, and reconnect on a sample.

API-Beispiel

Beispiel für Serverbefehl oder Webhook für eine maschinenseitige Aktion.

Die Befehlsfelder hängen von Maschinenschnittstelle, Firmware-Profil und davon ab, ob Zahlung oder Anwendung die Aktion auslöst.

POST /v1/devices/{device_id}/commands
Authorization: Bearer 
Content-Type: application/json

{
  "command": "vend",
  "slot": "B04",
  "reference_id": "ORDER-1001",
  "timeout_ms": 15000
}

# MQTT topic map
devices/{device_id}/commands
devices/{device_id}/events

Projekt-RFQ

Sagen Sie uns, was die Maschine tun, senden oder melden soll.

Senden Sie Maschinenmodell, Controller-Interface, Zielaktion und Datenfelder. Wir bestätigen den API/MQTT-Vertrag und den nächsten Mustertest.

A good first message

If you are unsure about the exact interface, send what you have. Photos often answer more than a long spec.

  • Machine type and target country
  • Machine photo, board photo, or wiring photo
  • Action after payment or API command
  • Need data upload? expected quantity?
Fastest first step
  • Send a machine photo
  • Describe the action after API or payment
  • Tell us if data upload is needed
Optional: Unternehmen, Menge, Schnittstelle und Datenbedarf

Eine kurze Nachricht reicht. Wir antworten meist innerhalb von 24 Stunden.

Have machine or board photos? Send them on WhatsApp — we usually review photos there first.

FAQ

Fragen, die vor einem Sample-Test typischerweise auftauchen.

Do you support MQTT?

MQTT 3.1.1 over TLS 1.2 with QoS 1 is the baseline. Broker, topic prefix, and authentication are confirmed per firmware profile.

Can we use our own backend?

Yes. The controller can deliver commands and events to your own API, webhook, or broker. The exact flow is confirmed on a sample.

How do you prevent duplicate commands?

The contract uses reference_id and event_id. Retry and deduplication behavior is confirmed in the firmware profile and tested on one machine.

What happens when the network is offline?

Event buffering and retry are part of the integration plan. Capacity, power-cycle retention, and backfill behavior must be tested before making a persistent-cache claim.

Maschinenfoto senden Projektanfrage senden