Fingerspot Developer API
REST API gateway for Fingerspot attendance devices (fingerspot.io SDK Online).
Response Patterns
Synchronous operations (get_attlog, get_device) return their full payload
immediately in the HTTP response body.
Asynchronous operations return an immediate confirmation
{"success": true, "trans_id": "..."} and deliver the actual result later
via an HTTP POST callback in JSON format to the webhook URL configured for the
target device. The trans_id value in the callback is always the same as the
trans_id sent in the initial request, allowing the client to correlate the
callback with the corresponding request.
Realtime Attlog Push
In addition to command-response callbacks, the platform continuously pushes
real-time attendance scan events (type: "attlog") to each device's configured
webhook URL whenever the device sends a scan — independent of any API call.
Webhook URL
Each device has a webhook URL registered out-of-band in the platform. The callback
expressions in this spec use {$request.body#/cloud_id} as a placeholder to
signal that the callback destination is determined by the cloud_id in the request
body; the actual URL is the one registered for that device.
Authentication
- HTTP: Bearer Auth
API token obtained from the Fingerspot Developer portal.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |