快递100云打印技术文档
一、自定义打印接口
如有打印发货单等其他类打印需求,可使用该接口。通过管理后台模板配置,配置自定义模板,实现自定义打印功能。
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://poll.kuaidi100.com/printapi/printtask.do
请求参数(header)
名称 | 类型 | 默认值 |
---|---|---|
Content-Type | string | application/x-www-form-urlencoded |
请求参数(body)
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:printOrder) |
key | 是 | string | 授权码,请申请企业版获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台获取 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
orderId | 否 | string | 贵司内部自定义的订单编号,需要保证唯一性,非必填 |
tempid | 是 | string | 通过管理后台的模板信息获取 |
siid | 是 | string | 打印设备,通过打印机输出的设备码进行获取 |
height | 否 | string | 打印纸的高度,以mm为单位,例如:100 |
width | 否 | string | 打印纸的宽度,以mm为单位,例如:75 |
salt | 否 | string | 签名用随机字符串 |
callBackUrl | 否 | string | 打印状态回调地址,默认仅支持http |
****** | 否 | string | 其他面单特殊需求参数显示,可以到后台-面单模板选择该模板,下方有对应产生列表 |
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
****** | ****** | 其他报文 |
1.4 返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": {
"taskId": "****", // 任务ID
******
}
}
1.5信息代码含义
代码 | 字段含义 |
---|---|
200 | 提交成功 |
400 | 参数错误 |
600 | 您不是合法的用户(即授权Key出错) |
601 | KEY已过期 |
500 | 服务器错误(即快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误) |
501 | 重复提交 |
503 | 验证签名失败 |
二、附件打印接口
为各应用产品提供的智能化打印解决方案。对接后可以让企业、个人实现PC/手机无线打印,远程打印,多人共享打印。打印内容包括但不限于文档、发票、发货单、快递单等,搭配云盒使用,支持激光、喷墨、针式、热敏打印机类型。让企业和个人打印更高效、更便捷。 通过接口上传打印内容,图片或PDF、Word等文件,即可打印该内容。
2.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
2.2 请求地址
请求参数(header)
名称 | 类型 | 默认值 |
---|---|---|
Content-Type | string | multipart/form-data |
请求参数(query)
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:imgOrder) |
key | 是 | string | 授权码,请申请企业版获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台的企业信息中查看 |
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 | 打印设备,通过打印机输出的设备码进行获取 |
└ callBackUrl | 否 | string | 打印状态回调地址,默认仅支持http |
body数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
file | 是 | file | 需要打印的附件 |
2.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
****** | ****** | 其他报文 |
2.4 返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": {
"taskId": "****", // 任务ID
******
}
}
2.5信息代码含义
代码 | 字段含义 |
---|---|
200 | 提交成功 |
400 | 参数错误 |
600 | 您不是合法的用户(即授权Key出错) |
601 | KEY已过期 |
500 | 服务器错误(即快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误) |
501 | 重复提交 |
503 | 验证签名失败 |
三、打印接口回调
通过上述接口提交的打印请求,进行打印状态返回。
3.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
3.2 请求地址
<form method="post" name="" action="[callbackUrl]">
<input type="text" name="taskId" value="{XXX}" />
<input type="text" name="param" value="{XXX}" />
<input type="text" name="sign" value="签名字符串" />
</form>
请求参数:
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID | |
sign | string | 加密字符串签名:MD5 (param +salt) | |
param | param | 参数主体 |
param数据结构:
参数名 | 类型 | 说明 |
---|---|---|
status | string | 状态编码,200:打印成功,201打印不成功 |
message | string | 状态描述 |
3.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 |
3.4 返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功"
}
说明:
字段名称 | 字段含义 |
---|---|
result | true表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃 |
returnCode | 200: 提交成功 500: 服务器错误 其他错误请自行定义 |
message | 返回的提示 |
其他信息快递100会忽略。
四、自定义生成图片接口
使用该接口可以自定义生成面单,发货单等的信息图片,并通过本地打印机打印。
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 | 业务类型(默认:默认:getPrintImg) |
key | 是 | string | 授权码,请申请企业版获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台的企业信息中查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
type | 是 | string | 业务类型,值为:30 |
orderId | 否 | string | 贵司内部自定义的订单编号,需要保证唯一性,非必填 |
tempid | 是 | string | 通过管理后台的打印模板配置信息获取 |
height | 是 | string | 打印纸的高度 |
width | 是 | string | 打印纸的宽度 |
** | 是 | string | 其他面单参数显示,可以到后台-面单模板选择该模板,下方有对应产生列表 |
4.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskid | string | 任务ID | |
imgBase64 | string | 面单BASE64编码图片 | |
****** | ****** | 其他报文 |
4.4 返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": {
"taskId": "****", // 任务ID
"imgBase64": "****", //面单BASE64编码图片
******
}
}
4.5 信息代码含义
代码 | 字段含义 |
---|---|
200 | 提交成功 |
400 | 参数错误 |
600 | 您不是合法的用户(即授权Key出错) |
601 | KEY已过期 |
500 | 服务器错误(即快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误) |
501 | 重复提交 |
503 | 验证签名失败 |
五、 硬件状态接口
获取云打印机设备通讯状态。
5.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
5.2 请求地址
https://poll.kuaidi100.com/printapi/printtask.do
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:devstatus) |
key | 是 | string | 授权码,请申请企业版获取 |
sign | 是 | string | 32位大写 ,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
siid | 是 | string | 设备码 |
5.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
onLine | string | 设备状态 | 1,在线,0未在线 |
5.4 提供数据内容
{
"result": true,
"returnCode": "200",
"message": "成功",
"data": {
"onLine": "****" //设备状态
}
}
5.5 信息代码含义
信息代码 | 字段含义 |
---|---|
200 | 提交成功 |
400 | 参数错误 |
600 | 您不是合法的用户(即授权Key出错) |
601 | KEY已过期 |
500 | 获取失败 |
503 | 验证签名失败 |
504 | 获取受限 |
六、指令打印接口
将原始打印指令进行zlib压缩,并转化为base64之后给到云打印机,实现云打印功能,适用于具有将打印内容转化成打印指令的商家以及从第三方接口(例:菜鸟、拼多多等)获取打印指令的商家(如第三方接口输出的指令已完成base64转化,则可直接通过云打印机打印)。
6.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
6.2 请求地址
https://poll.kuaidi100.com/printapi/printtask.do
请求参数(header)
名称 | 类型 | 默认值 |
---|---|---|
Content-Type | string | application/x-www-form-urlencoded |
请求参数(body)
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:printCommand) |
key | 是 | string | 授权码,请申请企业版获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台的企业信息中查看 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
content | 是 | string | 可识别打印指令,内容需我司硬件指令进行协商确定 |
siid | 是 | string | 打印设备,通过打印机输出的设备码进行获取 |
salt | 否 | string | 签名用随机字符串 |
callBackUrl | 否 | string | 打印状态回调地址,默认仅支持http |
6.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
taskId | string | 任务ID |
6.4 返回结果示例
{
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": {
"taskId": "****", // 任务ID
******
}
}
6.5信息代码含义
代码 | 字段含义 |
---|---|
200 | 提交成功 |
400 | 参数错误 |
600 | 您不是合法的用户(即授权Key出错) |
601 | KEY已过期 |
500 | 服务器错误(即快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误) |
501 | 重复提交 |
503 | 验证签名失败 |