Developer Documentation
Complete API documentation and developer resources for integrating Stellard access control into your applications.
API Endpoints
API Base URL
https://api.stellard.ch/trpc
Device Authentication Endpoints
Endpoints for device registration and authentication
POST /deviceAuth.register
Device registration with 4-digit PINGET /deviceAuth.getConfig
Retrieve device configurationPOST /deviceAuth.heartbeat
Send device status updatesPOST /deviceAuth.reportScan
Submit MRZ scan resultsPOST /deviceAuth.log
Send device log entriesAuthentication
Device authentication using API keys
API Key Format
sk_<64-character-hex-string>
Authentication Flow
- 1. Device registers with 4-digit PIN from dashboard
- 2. Server responds with permanent API key
- 3. Device stores API key for all future requests
- 4. Include API key in request body for all authenticated endpoints
Device Configuration
Configuration parameters sent to devices
idAgeMinimum age requirement (default: 18)
idCountdownStartCountdown start in seconds (default: 10)
idCountdownStopCountdown stop in seconds (default: 1)
idImageBackground image URL (optional)
showCameraDebug camera view (default: false)