Device SDK

One SDK to connect every Tipsoi device — Tipsoi, Fastface and Prompt series — behind a single HTTP REST API.

What it is

The Tipsoi SDK is a single library that connects all three device series — Tipsoi, Fastface and Prompt — behind one HTTP REST API. You integrate against that one API and the SDK handles every device family for you, so you never integrate each series separately.

When to use it

Use the Device SDK when your code runs close to the devices — a desktop app, an on-site server, or embedded in your own service — and you want to enrol people and read attendance directly, without going through the cloud.

How you talk to it

You call the SDK over HTTP REST — the same request/response style as the rest of this portal, and the only interface you deal with. Internally the SDK reaches devices over HTTP or MQTT depending on the series, but that is an implementation detail: you never handle MQTT or per-device transports yourself. One REST API covers card, fingerprint, face and palm operations across every series.

What you run

The SDK ships as a runnable component with step-by-step setup: install the runtime, configure it, run the provided script, and it’s working — then call its REST API from your code.

Endpoint reference

The full request-by-request endpoint reference generates from the unified SDK API spec, which is not published yet. This guide covers the concepts and shape of the SDK; the endpoint-level reference will appear here — navigable like the Software API and Device API — once the spec is finalised.