Skip to content

SDK Integration

The current CZUR Open SDK entry is the SDK Open local Runtime. Applications communicate with the Runtime embedded in the SDK App through local WebSocket/HTTP endpoints. The Runtime handles device discovery, live preview, capture, image processing, OCR, file conversion, and SANE scanning.

Integration Channels

LayerDescription
Command WSPrimary control channel for JSON-RPC-style system.*, auth.*, device.*, capture.*, and other commands.
Video WSVideo frame channel. Connect after video.start returns session_token and stream_id.
Local HTTPFile upload, download, and task artifact access channel.

Minimal Flow

ts
const ws = new WebSocket('ws://127.0.0.1:17090')

function call(method: string, params: Record<string, unknown> = {}) {
  const request_id = crypto.randomUUID()
  ws.send(JSON.stringify({ request_id, method, params }))
  return request_id
}

ws.addEventListener('open', () => {
  call('auth.create_session', { session_token: '<session-token>' })
  call('device.list')
})

Continue Reading

CZUR Open Platform Documentation