Confirm the machine interface
Send the controller label, wiring photos, and the action the machine must perform.
Integrasi MQTT & API
Integrasi MQTT dan API untuk kontrol machine-side
Panduan jalur antara backend, controller QuLink, dan mesin vending atau self-service. Endpoint, topik, autentikasi, dan payload dikonfirmasi per 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.
Kesesuaian proyek
Untuk tim yang menghubungkan mesin ke backend sendiri
Sinyal kebutuhan
- 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.
Yang perlu dikirim
- Foto mesin atau papan saat ini
- Catatan interface atau wiring
- Aksi target setelah API atau pembayaran
- Apakah perlu upload data
Kurang cocok jika
- 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.
Model integrasi
Satu kontrak, dua transport
HTTPS untuk perintah dan respons, MQTT untuk event real-time. Identitas perangkat, topik, autentikasi, dan QoS dikonfirmasi per proyek.
- 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
Alur kerja
Dari interface mesin ke hasil yang dikontrol API.
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.
Contoh API
Contoh perintah server atau webhook untuk aksi machine-side.
Field perintah bergantung pada interface mesin, profil firmware, dan apakah pembayaran atau aplikasi Anda yang memicu aksi.
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
Project RFQ
Ceritakan apa yang harus mesin lakukan, kirim, atau laporkan.
Kirim model mesin, interface controller, aksi target, dan field data. Kami konfirmasi kontrak API/MQTT dan uji sampel.
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
Pertanyaan yang biasanya muncul sebelum uji sampel.
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.
Use case terkait