Skip to content

API 调用约定

SDK Open 对外暴露本地 Command WS、Video WS 和 Local HTTP 三类接口。应用侧只需要与本地 Runtime 通信;云端授权、用量和 provider 调度由 Runtime 内部处理。

通用约定

项目说明
数据格式Command WS 使用 JSON 请求/响应;Video WS 使用文本事件 + 二进制帧;Local HTTP 用于文件上传和任务产物下载。
鉴权方式先通过 auth.create_session 建立连接绑定会话,再调用需要授权的 SDK 方法。
响应结构Command WS 返回 request_idcodemessagedatats
任务模型采集、图像增强、OCR、文件转换和 SANE 扫描可能返回 task_id,调用方按对应 *.get 方法轮询或监听事件。
国际化接口字段名保持英文稳定;面向用户的文案由应用侧按当前语言展示。

入口

CZUR Open Platform Documentation