Confirm the machine interface
Send the controller label, wiring photos, and the action the machine must perform.
Intégration MQTT et API
MQTT et API pour le contrôle machine
Guide du chemin entre votre backend, le contrôleur QuLink et une machine de distribution ou self-service. Les endpoints, topics, authentifications et payloads sont confirmés par firmware.
HTTPS APIMQTT topicsIdempotent commandsEvent callbacks
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 case | HTTPS API | MQTT |
|---|---|---|
| Backend sends a command | Request / response | Publish to command topic |
| Backend receives events | Webhook or polling | Subscribe to event topic |
| Best fit | Server-triggered actions | Real-time status and telemetry |
| Failure handling | HTTP status + retry | QoS + reconnect + idempotency |
The exact transport available on a machine depends on the controller, firmware, and network path.
Adéquation projet
Pour les équipes qui connectent une machine à leur backend
Signaux de besoin
- 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.
Ce qu'il faut envoyer
- Photos de la machine ou de la carte actuelle
- Notes d'interface ou de câblage
- Action cible après API ou paiement
- Besoin ou non d'upload de données
Pas adapté si
- 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.
Modèle d'intégration
Un contrat, deux transports
HTTPS pour les commandes et réponses, MQTT pour les événements temps réel. Identité, topics, authentification et QoS sont confirmés par projet.
- 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
Flux de travail
Des photos de la machine au flux testé.
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.
Exemple API
Exemple de commande serveur ou de webhook pour une action côté machine.
Les champs de commande dépendent de l'interface machine, du profil firmware et de l'élément qui déclenche l'action : paiement ou application.
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
Projet RFQ
Dites-nous ce que la machine doit faire, envoyer ou reporter.
Envoyez le modèle de machine, l’interface du contrôleur, l’action cible et les champs de données. Nous confirmons le contrat API/MQTT et le test.
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
FAQ
Questions fréquentes avant un test sur sample.
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.
Cas d'usage associés