Documentation
Reference for the node API and the hardware behind it.
Every page here traces its claims to a file in the firmware, the protocol package, or a bench record. Where a limit exists it is on the same page as the feature — the auth tiers with the routes they gate, the webhook signature with its delivery guarantees, the recovery ladder with the one fault it cannot clear.
Integrating
The surface, what gates it, and what it says when something goes wrong.
- The Node HTTP API: Scope, Auth, and LimitsWhat a node's local HTTP/JSON API covers, which tier gates each route, and the limits worth knowing before you integrate. The route table is linked, not copied.
- Node API Error Codes and Retry AdviceEvery error string the node API can answer with, the HTTP status it arrives on, the routes that emit it, and whether retrying the same request can ever work.
- Node API Auth: open, admin, and strictHow a node is locked down: the three apiMode tiers, the X-PN-Api-Key header, the separate update key, and the 15-second button hold that clears both.
- Node Webhooks: Push Events to Your POSPoint a node at a URL and it POSTs every event, signed with HMAC-SHA256. Delivery is deliberately best-effort — this page says exactly how weak it is.
Running a node
Getting one working, and what to do when one stops.
- Quickstart: From Box to First ReceiptSet a node up end to end — power, the setup Wi-Fi, joining your network, confirming the peripheral bound, printing — including when no printer is attached.
- Troubleshooting a Node: LEDs, USB, PrintingIt will not come up, will not print, or keeps restarting. Read the LED, read the status, work the USB recovery ladder — and know the one fault it cannot fix.
- Hardware Variants: the Six Declared SKUsSix firmware variants exist and they are not interchangeable. What each one declares, what a wrong image silently costs, and which of them are buildable at all.
What is deliberately not here
A route-by-route reference. A node registers more paths than any page here enumerates, and the authoritative list is the firmware’s own route table — a copy of it on a marketing site goes stale silently and reads as complete while it does. These pages publish the parts that do not move: the auth model, the error vocabulary, the limits, and the webhook contract. Everything else is described rather than tabulated.
Prefer to try it before reading it? The digital twin serves the same API on your laptop, and the support page takes a paste of a node’s status output.