一、收费标准,点我了解
可以不先买机器,直接提供远程机器参数供测试对接
要初步测试,告知下我们客服要开始测试,
调用API成功打印后,会把您提交打印的效果拍照给您看。
二、放纸方式
三、WIFI联网:
云打印机WIFI联网视频:
四、提供给测试用的参数
调用API先初步测试打印,会使用到的一些API参数,供测试对接看效果用:
授权码
key=”jgzLyzjw2122”;
应用密钥
secret=”371B26630A9BB55F0FB3DBDC07C81F8E”;
目标云打印机的设备码,提供的测试样机的设备码
siid=”KX100LAB73F442A21”;
四、附件打印接口
为各应用产品提供的智能化打印解决方案。对接后可以让企业、个人实现PC/手机无线打印,远程打印,多人共享打印。打印内容包括但不限于文档、发票、发货单、快递单等,搭配云盒使用,支持激光、喷墨、针式、热敏打印机类型。让企业和个人打印更高效、更便捷。 通过接口上传打印内容,图片或PDF、Word等文件,即可打印该内容。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://poll.kuaidi100.com/printapi/printtask.do?method=imgOrder&key={key}&t={t}¶m={param}&sign={sign}
请求参数(header)
名称 | 类型 | 默认值 |
---|---|---|
Content-Type | string | multipart/form-data |
请求参数(query)
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:imgOrder) |
key | 是 | string | 授权码,’jgzLyzjw2122’ |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret为”371B26630A9BB55F0FB3DBDC07C81F8E” |
t | 是 | string | 时间戳如:1576123932000 |
Θparam | 是 | param | 由其他字段拼接 |
└ orderId | 否 | string | 贵司内部自定义的订单编号,需要保证唯一性,非必填 |
└ height | 是 | string | 打印纸的高度,以mm为单位,例如:100 |
└ width | 是 | string | 打印纸的宽度,以mm为单位,例如:75 |
└ copyNum | 否 | string | 需要打印的份数,默认是一份 |
└ startPage | 否 | string | 打印范围,起始页,仅对多页文件支持,默认是打印整个文档 |
└ endPage | 否 | string | 打印范围,结束页,仅对多页文件支持,默认是打印整个文档 |
└ salt | 否 | string | 签名用随机字符串 |
└ siid | 是 | string | 打印设备,输出的设备码。测试样机设备码”KX100LAB73F442A21” |
└ callBackUrl | 否 | string | 打印状态回调地址,默认仅支持http |
body数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
file | 是 | file | 需要打印的附件 |
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
** | ** | 其他报文 |
1.4 返回结果示例{
1.5信息代码含义
代码 | 字段含义 |
---|---|
200 | 提交成功 |
400 | 参数错误 |
600 | 您不是合法的用户(即授权Key出错) |
601 | KEY已过期 |
500 | 服务器错误(即云端服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误) |
501 | 重复提交 |
503 | 验证签名失败 |
五、打印接口回调
2.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
2.2 请求地址
请求参数:
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
sign | string | 加密字符串签名:MD5 (param +salt) | |
param | param | 参数主体 |
param数据结构:
参数名 | 类型 | 说明 |
---|---|---|
status | string | 状态编码,200:打印成功,201打印不成功 |
message | string | 状态描述 |
2.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 |
2.4 返回结果示例{
说明:
字段名称 | 字段含义 |
---|---|
result | true表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃 |
returnCode | 200: 提交成功 500: 服务器错误 其他错误请自行定义 |
message | 返回的提示 |
其他信息会忽略。
六、 硬件状态接口
3.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
3.2 请求地址
https://poll.kuaidi100.com/printapi/printtask.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:devstatus) |
key | 是 | string | 授权码,key=’jgzLyzjw2122’ |
sign | 是 | string | 32位大写 ,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
siid | 是 | string | 设备码,测试样机设备码siid=”KX100LAB73F442A21” |
3.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
onLine | string | 设备状态 | 1,在线,0未在线 |
3.4 提供数据内容
3.5 信息代码含义
信息代码 | 字段含义 |
---|---|
200 | 提交成功 |
400 | 参数错误 |
600 | 您不是合法的用户(即授权Key出错) |
601 | KEY已过期 |
500 | 获取失败 |
503 | 验证签名失败 |
504 | 获取受限 |
七、指令打印接口
将原始打印指令进行zlib压缩,并转化为base64之后给到云打印机,实现云打印功能,适用于具有将打印内容转化成打印指令的商家以及从第三方接口(例:菜鸟、拼多多等)获取打印指令的商家(如第三方接口输出的指令已完成base64转化,则可直接通过云打印机打印)。
4.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
4.2 请求地址
https://poll.kuaidi100.com/printapi/printtask.do
请求参数(header)
名称 | 类型 | 默认值 |
---|---|---|
Content-Type | string | application/x-www-form-urlencoded |
请求参数(body)
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:printCommand) |
key | 是 | string | 授权码,key=’jgzLyzjw2122’ |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台的企业信息中查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
content | 是 | string | 可识别打印指令,内容需我司硬件指令进行协商确定 |
siid | 是 | string | 打印设备,输出机器的设备码。测试样机设备码siid=”KX100LAB73F442A21” |
salt | 否 | string | 签名用随机字符串 |
callBackUrl | 否 | string | 打印状态回调地址,默认仅支持http |
4.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID |
4.4 返回结果示例{
4.5信息代码含义
代码 | 字段含义 |
---|---|
200 | 提交成功 |
400 | 参数错误 |
600 | 您不是合法的用户(即授权Key出错) |
601 | KEY已过期 |
500 | 服务器错误(即云端服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误) |
501 | 重复提交 |
503 | 验证签名失败 |