Documentação da API
Central de ajuda/Documentação da API/API de dispositivos e Device Hub

API de dispositivos e Device Hub

Última atualização 2026-10-13

Registro de dispositivos na nuvem, emparelhamento do hub e protocolo local do Device Hub.

Registro de dispositivos na nuvem#

GET /api/wms/print-devices
GET /api/wms/print-devices?warehouse_id=<uuid>&hub_id=<uuid>&page=1&page_size=50
// -> items: id, name, model, device_type, connection, address,
//    is_default_label_printer, status, last_seen_at, hub_id, hub_name,
//    warehouse_id, warehouse_name, created_at

Online/offline é calculado a partir de last_seen_at (limite de 2 minutos). O Hub sincroniza as impressoras automaticamente após o emparelhamento.

Protocolo local do Device Hub#

O emparelhamento e a impressão local passam pelo app Device Hub via WebSocket em ws://127.0.0.1:18443 (JSON com action + params; eventos como { event, data }). hub.info e hub.pair não exigem auth; o resto exige o token do emparelhamento.

Emparelhar com o código de 6 dígitos
// 1. user reads the 6-digit code shown in the Device Hub tray app
// 2. pair (no auth required):
ws -> { "action": "hub.pair", "params": { "code": "482910" }, "id": "1" }
ws <- { "id": "1", "ok": true, "data": { "token": "<hub-token>" } }
// 3. store the token locally; all later requests send it (see device-hub lib).
//    success envelope: { id, ok: true, data }
//    error envelope:   { id, ok: false, error: { code, message } }
  • hub.info — versão/plataforma do hub, sem auth.
  • printer.list → { printers }; printer.discover inicia varredura USB + rede (mDNS), resultados via eventos printer.discovered.
  • printer.print { device_id, data: "<zpl>", copies } → { job_id }; conclusão/falha via evento print.job_completed.
  • printer.status { device_id } — estado em tempo real (sem papel/fita, tampa aberta).
  • device.register { device_id, name, is_default } — registra um dispositivo descoberto (também reporta ao registro na nuvem).

Vinculação do relé na nuvem#

hub.cloud_bind — habilitar o relé na nuvem
ws -> { "action": "hub.cloud_bind", "params": {
  "supabase_url": "https://<ref>.supabase.co",
  "supabase_anon_key": "<anon-key>",
  "organization_id": "<uuid>",
  "warehouse_id": "<uuid>"        // optional
}, "id": "2" }
ws <- { "id": "2", "ok": true, "data": {} }
// after binding, the Hub pulls print_jobs with its cloud credentials and syncs the device ledger.