Confirm the machine interface
Send the controller label, wiring photos, and the action the machine must perform.
Integração MQTT e API
MQTT e API para o controle da máquina
Guia do caminho entre seu backend, o controlador QuLink e uma máquina de vending ou self-service. Endpoints, topics, autenticação e payloads são confirmados 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.
Adequação do projeto
Para equipes que conectam uma máquina ao próprio backend
Sinais de necessidade
- 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.
O que enviar
- Fotos da máquina ou placa atual
- Notas de interface ou fiação
- Ação alvo após API ou pagamento
- Se precisa de upload de dados
Não é adequado se
- 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 integração
Um contrato, dois transportes
HTTPS para comandos e respostas, MQTT para eventos em tempo real. Identidade, topics, autenticação e QoS são confirmados por projeto.
- 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
Fluxo de trabalho
Das fotos da máquina ao fluxo testado.
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.
Exemplo de API
Exemplo de comando de servidor ou webhook para uma ação no lado da máquina.
Os campos do comando dependem da interface da máquina, do perfil de firmware e de se o pagamento ou o aplicativo aciona a ação.
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
Projeto RFQ
Conte o que a máquina precisa fazer, enviar ou reportar.
Envie o modelo da máquina, a interface do controlador, a ação desejada e os campos de dados. Confirmamos o contrato API/MQTT e o teste.
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
Perguntas comuns antes de um teste de amostra.
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