Listar todas as suas impressoras

Listar as impressoras

GET https://www.expedy.fr/api/v2/printers/all

Devolve todas as impressoras na nuvem associadas à sua conta, com o respetivo UID, nome, estado e configuração. Use-o para descobrir o printer_uid de que precisa para enviar uma tarefa de impressão.

URL base: https://www.expedy.fr/api/v2


Autenticação

Este endpoint requer um cabeçalho Authorization contendo o seu SID e o seu TOKEN, separados por um único caractere de dois-pontos.

Authorization: <SID>:<TOKEN>

⚠️ Isto não é um token Bearer. Não adicione um prefixo Bearer ou Basic — envie o valor bruto SID:TOKEN.

Ambos os valores estão disponíveis na consola Expedy, na secção API. Todos os pedidos devem ser feitos através de HTTPS (TLS).

Exemplo cURL:

curl "https://www.expedy.fr/api/v2/printers/all" \
  -H "Authorization: <SID>:<TOKEN>"

Resposta 200 OK

Devolve um array JSON de objetos de impressora (array vazio se nenhuma impressora estiver registada).

Campo Tipo Descrição
printer_uid string Identificador único da impressora. É o valor que passa como {printer_uid} ao endpoint de impressão.
printer_name string Rótulo legível definido na consola (ex.: Kitchen, Lobby).
printer_status string Estado de ativação da impressora. 1 = ativa, 0 = suspensa. É um sinalizador administrativo controlado exclusivamente pela ExpedyPRINT — não um indicador de conectividade em tempo real.
printer_width string Largura do papel em milímetros: 58, 80 ou 104. Use-a para dimensionar o seu conteúdo (32 / 48 caracteres por linha para 58 / 80 mm).
printer_graphic_mode string Modo de renderização de imagens configurado na consola: 0 = Graphics (predefinição), 1 = BitImageRaster, 2 = BitImageColumn. Consulte Imagem e logótipo.
printer_print_mode string Código numérico do modo de impressão da impressora (configuração específica do dispositivo).

ℹ️ printer_status é um sinalizador de ativação, não uma verificação de conectividade em tempo real. 0 significa que a impressora foi suspensa pela ExpedyPRINT — normalmente devido a um problema de pagamento ou ao incumprimento das nossas condições de utilização — e não imprimirá enquanto não for reativada. Para verificar se um dispositivo ativo está fisicamente acessível e a imprimir, envie uma impressão de teste em vez de confiar neste campo.

Exemplo de resposta:

[
  {
    "printer_uid": "UP3VS5JXRYA",
    "printer_name": "Lobby",
    "printer_status": "1",
    "printer_width": "58",
    "printer_graphic_mode": "0",
    "printer_print_mode": "0"
  },
  {
    "printer_uid": "MMAAZ112PI",
    "printer_name": "Kitchen",
    "printer_status": "1",
    "printer_width": "80",
    "printer_graphic_mode": "0",
    "printer_print_mode": "0"
  },
  {
    "printer_uid": "8L35EGFH8S7",
    "printer_name": "Warehouse",
    "printer_status": "1",
    "printer_width": "104",
    "printer_graphic_mode": "0",
    "printer_print_mode": "1"
  }
]

Erros

Qualquer estado diferente de 2xx devolve um envelope JSON com um campo message:

{
  "message": "Missing ExpedyPRINT API credentials (SID / token)."
}
Estado Significado
401 / 403 Credenciais ausentes ou inválidas (SID / TOKEN).

Leia sempre o campo message em vez de confiar apenas no código de estado.


Próximo passo

Assim que tiver um printer_uid, envie-lhe conteúdo:

POST https://www.expedy.fr/api/v2/printers/{printer_uid}/print

Consulte a referência do endpoint de impressão para o corpo do pedido e as etiquetas de layout.


SDK e exemplos

Prefere um cliente pronto a usar? Use o SDK oficial de Node.js — encapsula a autenticação e a listagem de impressoras:

👉 github.com/ExpedyDev/expedy-sdk-node