Devices API

v1Estável

Gerenciamento de terminais e equipamentos

Visão Geral

Gerencie terminais de ponto, catracas, câmeras e equipamentos conectados. Monitore status e configure parâmetros.

Documentação

Autenticação

API Key com escopo devices:read e devices:write passada no header X-Api-Key.

Health Check

Retorna uptime, versão de firmware, temperatura e status de conectividade.

Comandos

Suporte a reboot, sync, unlock e update-firmware via POST /commands.

Webhooks

Eventos de offline, reconexão e erro de hardware via webhook.

Referência da API

GET/v1/devices
GET/v1/devices/{id}
PATCH/v1/devices/{id}
GET/v1/devices/{id}/health
POST/v1/devices/{id}/commands
exemplo.ts
sandbox
// Enviar comando de sincronização
const response = await fetch(
  'https://api.smartpoint.app.br/v1/devices/terminal-01/commands',
  {
    method: 'POST',
    headers: { 'X-Api-Key': 'SUA_API_KEY', 'Content-Type': 'application/json' },
    body: JSON.stringify({ command: 'sync' }),
  }
);
const { jobId, status } = await response.json();