Skip to content

SDK Open Local Runtime

The SDK Open local runtime exposes CZUR devices, local document processing, and online enhancement capabilities as local HTTP + WebSocket services. Third-party apps first get an API key from the Open Platform, then create a connection-bound session through the local Command WS.

After installing the runtime, open the local demo site first to validate the end-to-end flow, then continue with the modules below.

Capability Modules

ModuleMethod prefixNotes
System and authsystem.*, auth.*Runtime probe, capability catalog, API key session, and offline activation.
Device and videodevice.*, video.*Device discovery, open/close, preview stream, and realtime processing profile.
Capturecapture.*Capture by profile and produce original, processed, thumbnail, and asset URLs.
Image processingimage.process*Page processing, curve flattening, selected-area crop, color mode, and format-preserving processing.
Image enhancementimage.enhance*Offline/online pipelines, task query, cancellation, and workflow storage.
OCR and recognitionocr.*, recognition.*OCR export, text block extraction, and static barcode/QR detection.
File conversionfile.convertConvert between images, PDF, OFD, and TIFF.
SANE scanningsane.*Linux SANE scanner discovery, options, scan tasks, and scan post-processing.

CZUR Open Platform Documentation