Documentation développeur Caisses ProxyHardware
November 26, 2025 at 2:48 AMProxy hardware
Le proxy hardware sert d’interface entre l’IHM et les périphériques. Il expose des api et un canal websocket.
APIs
/health
Equivalent à l’api Health NEED
GET /health/version
GET /health/ok
GET /health/whoami
Renvoie le nom (hostname) du raspberry pi
GET /health/proc
Renvoie différentes informations à propos du process en cours
/escpos
Gestion de l’imprimante thermique Epson T88V
### POST /escpos/openCashDrawer
Ouvre le tirroire caisse
POST /escpos/printImage
Imprime des tickets
GET /escpos/printerInfo
Récupère des infos sur l’imprimante
/card
Utilisation du TPE pour les cartes bancaires
GET /card/info
Obtient des infos sur le TPE
POST /card/pay
Lance un paiement par carte
/checkPrinter
Utilisation du TPE pour les chèques
GET /checkPrinter/info
Obtient des infos sur le TPE
POST /checkPrinter/print
Lance un paiement par chèque (imprime le chèque)
/tpa
Api pour le TPA
Websocket
Url : /ws
Le canal websocket permet d’échanger différents types de messages :
{
"type": "..."
}
Un message envoyé est renvoyé vers toutes les connexions websocket, y compris l’expéditeur.
Type hello
Envoyé quand un écran de retour client est connecté.
{
"type": "hello"
}
Type html
Envoyé à l’écran de retour client pour lui dire quoi afficher.
{
"type": "html",
"html": "contenu"
}
Type blackout
Envoyé à l’écran de retour client pour afficher un écran noir.
{
"type": "blackout"
}
Type barcode
Envoyé quand le scanner de code-barre a lu un code.
{
"type": "barcode",
"value": "123Avaleurduqrcode"
}
Type clock
Horloge
{
"type": "clock",
"value": "..."
}
Utilisable : new Date(message.value)