These endpoints require the apiToken (the initial JWT obtained from /api/auth). They are used for monitoring and general hardware management.

Status & General Configuration

Get Kiosk Status

GET [host]/api/kiosk/[kiosk_id]/status

Description: Retrieves the current operational status of the kiosk's hardware components, including CPU, printers, TPV, scanner, and more.

Security

Type	Header	Value
Integrator Token	`Authorization`	`Bearer <your_auth_token>`

Response Example (200)

{
    "success": true,
    "data": {
        "cpu": "Normal",
        "printer": "Online",
        "tpv": "Ready",
        "scanner": "Online",
        "bill_reader": "Ready"
    },
    "request_id": "j1f4f2b962b400714301bd3dcb143l2"
}

Restart & Specific Hardware Status

These maintenance endpoints allow you to monitor the health of individual components and perform physical resets if an error occurs.

Authentication: Requires the Integrator Token (apiToken) in the Authorization header.

🖨️ Printer Maintenance

Get Printer Status

GET [host]/api/kiosk/[kiosk_id]/printer/status

Description: Checks the current state of the printer, including paper levels and internal errors.

Restart Printer

POST [host]/api/kiosk/[kiosk_id]/printer/restart

Description: Performs a physical power cycle/restart of the printer unit.

🗂️ Card Dispenser Maintenance

Get Dispenser Status

GET [host]/api/kiosk/[kiosk_id]/dispenser/status

Description: Returns the status of the card dispenser, such as hopper capacity (empty/low) and card positioning.

Restart Dispenser

POST [host]/api/kiosk/[kiosk_id]/dispenser/restart

Description: Performs a physical power cycle/restart of the card dispenser unit.

📸 Scanner Maintenance

Restart Scanner

POST [host]/api/kiosk/[kiosk_id]/scanner/restart

Description: Performs a physical power cycle/restart of the document scanner.

[!WARNING] Use the Restart endpoints only when a component is unresponsive or reporting a critical error. Physical restarts may interrupt any active user session.