Confirm the machine interface
Send the controller label, wiring photos, and the action the machine must perform.
Integración MQTT y API
MQTT y API para el control de la máquina
Guía del camino entre tu backend, el controlador QuLink y una máquina de vending o self-service. Endpoints, topics, autenticación y payloads se confirman por 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.
Ajuste del proyecto
Para equipos que conectan una máquina a su backend
Señales de necesidad
- 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.
Qué enviar
- Fotos de la máquina o placa actual
- Notas de interfaz o cableado
- Acción objetivo después de API o pago
- Si necesita carga de datos
No es adecuado 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.
Modelo de integración
Un contrato, dos transportes
HTTPS para comandos y respuestas, MQTT para eventos en tiempo real. Identidad, topics, autenticación y QoS se confirman por proyecto.
- 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
Flujo de trabajo
De las fotos de la máquina al flujo probado.
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.
Ejemplo de API
Ejemplo de comando de servidor o webhook para una acción del lado de la máquina.
Los campos del comando dependen de la interfaz de la máquina, el perfil de firmware y si el pago o la aplicación activa la acción.
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
Proyecto RFQ
Cuéntanos qué debe hacer, enviar o reportar la máquina.
Envía el modelo de máquina, la interfaz del controlador, la acción objetivo y los campos de datos. Confirmamos el contrato API/MQTT y la prueba.
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
Preguntas habituales antes de un test de muestra.
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.
Casos relacionados