帮助中心-API接入说明

易云打印API接入说明

易云打印API接口是对外提供给第三方程序实现自动化打印的一项服务,开发者使用API接口可实现各种自动化打印需求,如:订单,派货,通知等自动化打印需求,并且API接口支持即时或定时执行某项打印任务。

场景如:电商网站用户的订单信息立即打印到卖家所在的本地打印机。

打印接口地址

http接口地址:http://www.eyprint.com/public/
https接口地址:https://www.eyprint.com/public/
*使用POST方式请求,请求成功后返回json格式的结果。

打印接口请求参数说明
字段名称 字段类型 说明
key 字符串(必需) 每台打印机都有唯一32位长API key,可以从开发者中心中申请。
sourceFile 公网URL(必需) 指定打印文件的URL地址,必需是公网可访问的地址
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 整数 正在处理的任务队列数,最多不能超过50条

打印机在线状态查询接口

http接口地址:http://www.eyprint.com/public/state/
https接口地址:https://www.eyprint.com/public/state/
*使用POST|GET方式请求,请求成功后服务器将返回json格式。

请求参数
字段名称 字段类型 说明
key 字符串(必需) 每台打印机都有唯一32位长API key,可以从开发者中心中申请。

返回结果
字段名称 字段类型 说明
result Fail或success 查询结果
msg 字符串 请求结果描述
online true或false 在线状态
state true或false 打印机启用状态

请求打印接口测试
 获取API key
mm X 高mm
左边距mm 上边距mm
*:未开通包月的API key 每次请求需收费0.05元.
*:调用接口前请将打印机状态设置为启用.
*:打印任务状态可在用户中心->打印记录中查看详情.
示例下载
php-api-demo下载   python-api-demo下载   java-api-demo下载   php生成PDF文件示例