You do not need to read every page. Pick your goal and follow its references. Already integrating? Search for signing, queues, callbacks or an API name.
先了解云打印能做什么
还没决定怎么接入?先看平台、你的系统和打印机各自做什么。
See setup and usage steps3references
Before you start不用写代码,先确定你的使用场景和设备类型。
- 看懂整个流程了解顾客下单后,图片怎样变成打印任务。什么是云打印 →
- 认识设备和任务编号分清设备编号、密钥、订单号和任务号。云打印-核心概念 →
- 选用适合的客户端按桌面机、自助机或本地接入方式选择。云打印-客户端类型 →
Keep in mind选好接入方式后,再看对应分类的接口;不是每台设备都支持所有功能。
Browse all references · 快速开始 →从网站、App 或小程序下单打印
把你的订单交给指定设备打印,再把进度和结果显示给顾客。
See setup and usage steps5references
Before you start准备已接入的设备、设备编号和密钥、可访问的图片地址,以及实际打印尺寸。密钥留在服务端,不放进网页。
- 确认设备可用查看离线、空闲、打印中、故障或维护状态。查询打印机状态 →
- 提交第一笔任务传入订单号、图片和尺寸,保存返回的任务号。发送打印任务 →
- 需要时确认开始仅适用于设备设置了二次确认的情况。开始打印 →
- 查询这笔任务用任务号查看排队、打印进度,以及创建、开始、完成时间。查询指定打印任务 →
- 接收打印结果在你的系统提供回调地址,接收完成或异常通知。打印任务回调 →
Keep in mind提交成功不等于打印完成。保存返回的任务号;只有设备设置为二次确认时,才需要再调用“开始打印”。
Browse all references · 接口-互联网(桌面设备) →让顾客在自助机上完成打印
顾客选图下单,设备排队打印;你的系统接收打印和出货结果。
See setup and usage steps4references
Before you start先确认自助客户端版本、商品与通道配置、库存和回调地址。通道参数只用于支持通道的自助设备。
- 提交顾客订单按该分类的参数说明发送打印任务。发送打印任务 →
- 核对剩余商品在继续接单前确认设备库存。查询实时库存 →
- 接收任务与出货结果按 V2 定义处理完成、暂停、失败、出货等状态。打印任务回调V2 →
- 接收设备异常把故障、库存或墨量提示交给运营人员处理。打印机状态回调V2 →
Keep in mindV2 回调和旧回调的状态值不同,不能混用;V2 需要对应的客户端版本,先与技术人员确认。
Browse all references · 接口-互联网(自助机) →在店里或工厂的局域网内打印
你的系统和终端软件在本地通信,发送任务并接收设备消息。
See setup and usage steps4references
Before you start准备终端软件、同网段的网络连接和 TCP 通信配置,先按对接指南建立连接。
- 建立本地连接先配置终端软件与 TCP 通信。对接指南 →
- 保持连接按心跳协议维持通信。发送心跳包 →
- 创建本地打印任务按事件格式发送打印内容。创建打印任务事件 →
- 接收任务状态根据终端返回的任务消息更新界面。打印机任务状态回调 →
Keep in mind这里使用终端 TCP 事件协议,不是互联网 OpenAPI,也不是嵌入式 CMD 协议。
Browse all references · 接口-局域网终端(TCP) →把打印内机接入自己的设备
做整机集成时,先确认内机协议,再按命令查询、打印和读取进度。
See setup and usage steps5references
Before you start先确认内机型号、固件和设备 IP;当前通信说明使用本地 HTTP 地址与 CMD_ID 命令。
- 先读通信约定核对请求地址、命令和成功/失败返回值。通信约定与通用规范 →
- 查询内机用 CMD 00 获取对应信息。CMD 00 — 查询 →
- 发送打印命令按 CMD 01 文档准备打印参数。CMD 01 — 打印 →
- 读取打印进度用 CMD 03 跟踪打印过程。CMD 03 — 打印进度 →
- 对照代码示例只对照本协议的调用方式,不套用到互联网接口。调用示例 →
Keep in mind分类名称含 TCP,但实际请求方式以“通信约定与通用规范”为准。这里的调用示例只适用于嵌入式协议。
Browse all references · 接口-嵌入式直连(TCP) →先用 AI 做图,再交给设备打印
让顾客上传图片、选择效果,合成后把图片接进你的打印下单流程。
See setup and usage steps5references
Before you start准备商户编号、商户密钥和生图回调地址。AI 使用商户凭据,不是打印设备密钥。
- 看生图接入流程先了解模板、任务、回调和消费查询的关系。对接指南 →
- 核对计费方式确认使用规则,实际费用以当前配置为准。计费说明 →
- 选择可用模板获取模板编号与对应效果。获取模板 →
- 生成商户签名使用 AI 接口的商户签名规则。生成签名 →
- 提交合成并接收图片保存任务标识,按本文的回调说明接收图片结果。创建AI任务 →
Keep in mindAI 任务是异步的:返回任务标识后等回调拿到合成图,再另行提交打印任务;生图成功不会自动完成打印。
Browse all references · 接口-AI生图 →我不写代码,先把设备用起来
安装软件、绑定设备,或用治具模板做批量打印。
See setup and usage steps4references
Before you start准备设备、电脑、网络和已开通的账号;按你使用的客户端选择手册。
- 安装客户端按安装指引检查软件和设备连接。客户端-软件安装指引 →
- 配置自助客户端查看绑定、下单展示和日常运维方法。客户端-互联网|自助机-操作手册 →
- 配置局域网终端按本地通信方式配置客户端。客户端-局域网|TCP-操作手册 →
- 用治具做批量任务准备模板和排列,再导入数据生成打印图。创建治具打印任务-操作指南 →
Keep in mind治具任务按“内容模板 → 治具排列 → 导入数据生成任务”操作,先确认实际尺寸和设备适配。
Browse all references · 客户端软件手册 →Troubleshooting and job controls
How to read an API reference
- Check applicabilityCheck the device type, client version and integration type, especially kiosk-only features and V2 callbacks.
- Read the request and parametersUse the exact endpoint, method and required fields. Parameter names such as taskid and task_id vary by API.
- Check responses and updatesCheck the business result, not just HTTP success. Job status, device status and callback versions use different values.
Need an account or unsure which integration your device supports? Tell support your model, intended workflow and issue before you start.
Have an account? Check your devices in the console →This page lists currently published English references only. For local protocols, AI or a missing manual, ask technical support for the appropriate documentation.