Skip to content

CZUR Open PlatformDocumentation Center

A unified documentation portal for Open Platform accounts, API keys, and the CZUR local SDK runtime.

1

Prepare an Open Platform account

Register or sign in, create an app, and choose the online or offline authorization mode required by your deployment.

2

Issue an API key

Create an API key for the app, configure SDK tier, VID/PID device scope, and expiration policy.

3

Start the local runtime

Start `sdk_open_app` or the embedded product runtime, then connect to `ws://127.0.0.1:17090`.

4

Call device and document capabilities

After `auth.create_session`, call device, video, capture, enhancement, OCR, conversion, and SANE APIs.

Minimal TypeScript Call

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

function request(method: string, params: Record<string, unknown> = {}) {
  command.send(JSON.stringify({
    request_id: `req-${Date.now()}`,
    method,
    params,
    client: {
      source: 'your-app',
      protocol_version: '2.0.0',
      trace_id: `trc-${Date.now()}`
    }
  }))
}

command.addEventListener('open', () => {
  request('system.ping')
  request('auth.create_session', { token: 'sk-sq-v1-...' })
})

See SDK Open Quick Integration for complete samples.

CZUR Open Platform Documentation