Raven documentation

For system integrators bridging the devices inside a venue: the API your software calls, and the runbook your technician follows on site.

Start here

What Raven is, whether it fits, and a printed ticket in ten minutes.

What Raven is

A cloud bridge to the devices inside your customers’ venues: outbound-only, no inbound ports, no VPN.

Quickstart

From an API key to a printed ticket, in one request.

Four nouns and one lifecycle. Read once; the rest of the docs assume them.

The four nouns

Connector, physical device, logical device, interaction, and why you integrate against the logical one.

Your account is your business

One account spans every venue you run. What that means for API keys and blast radius.

For the developer. Authenticate, send work, and find out what happened.

Authentication

API keys: getting one, using one, and what it can reach.

Printing a ticket

Submit a job, read the 202, and follow it to a real outcome.

Ticket XML

The full tag reference: text, layout, tables, QR, barcodes, images.

Weighing

Synchronous weigh and tare, watching a scale live, and what an unstable reading means.

Bridging any device

A transparent HTTP proxy into the venue, for hardware Raven does not model.

The on-site procedure, for the technician performing it. Printable.

Field runbook

Installing a connector on site: prerequisites, enrollment, discovery, assignment, verification.

Every control in the dashboard, one page per device class, with the dialog it lives in.

Connector settings

Heartbeat, discovery ports, and the image-host guard.

Printer settings

Command language, roll or label stock, and the two sharing switches.

Scale settings

The driver, why you pick it by hand, and what is supported today.

Bridge settings

Registering hardware Raven cannot discover, and why there is nothing to configure.