易云打印API接口是对外提供给第三方程序实现自动化打印的一项服务,开发者使用API接口可实现各种自动化打印需求,如:订单,派货,通知等自动化打印需求,并且API接口支持即时或定时执行某项打印任务。
场景如:电商网站用户的订单信息立即打印到卖家所在的本地打印机。
V1打印接口地址
字段名称 | 字段类型 | 说明 |
key | 字符串(必需) | 每台打印机都有唯一32位长API key,可以从开发者中心中申请。 |
sourceFile | 公网URL(必需) |
指定打印文件的URL地址,必需是公网可访问的地址。 部分HTTPS协议不兼容,建议采用HTTP协议。 |
Type | 字符串(必需) | 指定打印文件的文件类型, 可支持:img,pdf,html,doc,docx,xls,xlsx,ppt,pptx img,pdf文件类型打印速度快,稳定可靠。 html,doc,docx,xls,xlsx,ppt,pptx文件类型打印速度较慢。 |
filename | 字符串(可选) | 指定平台内打印记录用以显示区分的名字。 未指定明平台则随机生成一个文件名。 |
Landscape | 字符串(可选) | 打印内容是否旋转90度。 取值:True | False 默认值:False |
trueColor | 字符串(可选) | 是否彩色打印(需打印机支持彩色打印)。 取值:True | False 默认值:False |
Copies | 整数类型(可选) | 打印份数 取值范围:1~100 默认值:1 |
Scaling | 字符串(可选) | 打印内容超出纸张时是否适应纸张大小。 取值:True | False 默认值:False |
Duplex | 字符串(可选) | 双面打印。 取值:Simplex | Vertical | Horizontal Simplex:单面打印 Vertical:双面长边 Horizontal:双面短边 默认值:Simplex |
printRange | 字符串(可选) | 打印页码范围,打印类型为图片时无效。 取值示例:1,2,4,5,8,10 默认值:all |
tasktype | 字符串(可选) | 打印任务类型,可选定是立即打印还是定时打印。 取值:now | plan 默认值:now |
printtime | 时间戳(可选) | 打印任务执行的时间点。 当指定打印任务类型为plan(定时打印)时生效。 未指定时则为服务器当前时间。 |
Width | 小数类型(可选) | 定义打印内容的宽度。 PDF文件不支持该设置。 Scaling值为False时起效。 默认值为打印客户端设置的值。 单位:mm(毫米) |
Height | 小数类型(可选) | 定义打印内容的高度。 PDF文件不支持该设置。 Scaling值为False时起效。 默认值为打印客户端设置的值。 |
leftMargin | 小数类型(可选) | 定义打印内容的左边留白。 PDF文件不支持该设置。 默认值:0(自动)大于0为手动 单位:mm(毫米) |
topMargin | 小数类型(可选) | 定义打印内容的顶边留白。 PDF文件不支持该设置。 默认值:0(自动)大于0为手动 单位:mm(毫米) |
ttsText | 字符串(可选) | 语言播报文字,最长可接受20个中文字符 。 |
callBackUrl | 公网URL(可选) | 指定打印机执行状态回调地址,必需是公网可访问的地址。 客户端打印结束后将打印结果以post方式回调到该URL, 回调字段包含: taskID(任务编号) status(打印状态) pageCount(打印页数) |
字段名称 | 字段类型 | 说明 |
result | Fail或success | 请求任务状态结果 |
msg | 字符串 | 请求任务结果描述 |
taskID | 字符串 | 打印任务唯一标识编号 |
queue | 整数 | 正在处理的任务队列数 |
reviewUrl | 字符串 | 打印预览地址,V2版本提供 |
pageCount | 整数 | 文件页面数,V2版本提供 |
字段名称 | 字段类型 | 说明 |
key | 字符串(必需) | 每台打印机都有唯一32位长API key,可以从开发者中心中申请。 |
字段名称 | 字段类型 | 说明 |
result | Fail或success | 查询结果 |
msg | 字符串 | 请求结果描述 |
online | true或false | 在线状态 |
state | true或false | 打印机当前启用状态 |
字段名称 | 字段类型 | 说明 |
key | 字符串(必需) | 每台打印机都有唯一32位长API key,可以从开发者中心中申请。 |
state | 字符串 True或False(必需) | True:启用打印机 False:停用打印机 |
字段名称 | 字段类型 | 说明 |
result | Fail或success | 设置结果,Fail失败,success成功 |
msg | 字符串 | 请求结果描述内容 |
state | true或false | 打印机当前启用状态 |