• 首页
  • 产品中心
    • P16云打印

    • P15云打印

    • Kiosk/票据打印机

    • POS/平台式打印机

    • 移动打印机

    • 面板打印机

  • 渠道合作
  • 成功案例
  • 关于我们
  • 开放平台
登录 注册

接入指引

  • 步骤说明
  • 请求公共参数说明
  • 返回公共参数说明

接口列表

  • 添加打印机【必接】
  • 打印订单
  • 删除打印机
  • 修改打印机信息
  • 清空待打印订单
  • 查询订单状态
  • 查询打印机订单数
  • 查询打印机状态

下载中心

  • SDK下载
  • 驱动与支持

接口返回值

  • 接口返回值

常见问题

  • 常见问题

接入指引

开发者接入API步骤

第一步:注册开发者账号

到 https://www.weihuang.cn/home/user/login.html (以下统称‘炜煌云后台’)注册开发者账号,获得UKEY,账号和UKEY是开发者API接入的重要身份识别参数。


第二步:对接API

  1. 1、 【必接】添加打印机到开发者账户(可批量)
    注意:打印之前必须添加SN、KEY到开发者账户(查看打印机身标签)开发者可以在炜煌管理后台页面人工添加,或者通过本接口程序添加。
  2. 2、 【必接】打印订单
  3. 3、 删除打印机(可批量)
  4. 4、 修改打印机信息
  5. 5、 清空待打印队列
  6. 6、 查询订单是否打印成功
  7. 7、 查询某台打印机某日订单统计数
  8. 8、 查询某台打印机状态

特别声明:

1、返回结果皆为json格式数据。

2、以下每个接口只列出私有参数和返回结果的data参数,其他请看请求和返回的公共参数说明。

特别注意:开发者自己写的请求以表单方式提交数据,请求头需要使用Content-Type: application/x-www-form-urlencoded,请勿使用其它方式提交数据

3、相关SDK下载 点击查看

请求公共参数说明:

所有请求都必须传递的参数。
请求参数名 是否必须 类型 说明
user 必须 string 炜煌云后台注册用户名。
timestamp 必须 string 当前UNIX时间戳,10位,精确到秒。
sign 必须 string 对参数 user+UKEY+timestamp拼接后(+号表示连接符)进行SHA1加密得到签名,值为40位小写字符串。

返回公共参数说明

返回参数名 类型 说明
code int 返回码,正确返回0,【注意:结果正确与否的判断请用此返回参数】,错误返回非零。
msg string 结果提示信息,正确返回”ok”,如果有错误,返回错误信息。
data 不指定 数据类型和内容详看私有返回参数data,如果有错误,返回null。

批量添加打印机

功能描述:

批量添加打印机,请严格参照格式说明:

批量添加规则:

打印机编号SN(必填) # 打印机识别码KEY(必填) # 备注名称(选填) # 流量卡号码(选填),多台打印机请换行(\n)添加新打印机信息,每次最多100行(台)。

每次最多添加100台。

请求URL:

https://www.weihuang.cn/api/open/addPrts

请求方式:

POST(推荐),GET

请求参数:
请求参数名 是否必须 类型 说明
user 必须 string 炜煌云后台注册用户名。
timestamp 必须 string 当前UNIX时间戳,10位,精确到秒。
sign 必须 string 对参数 user+UKEY+timestamp拼接后(+号表示连接符)进行SHA1加密得到签名,值为40位小写字符串。
content 必须 string 打印机编号(必填) # 打印机识别码(必填) # 备注名称(选填) # 流量卡号码(选填),多台打印机请换行(\n)添加新打印机信息,每次最多100台。

返回参数说明:

参数名 类型 说明
data array 返回1个数组,包含成功和失败的信息,详看示例。

返回示例:

正确:

  1. {
  2. "ok":[
  3. "316500010# abcdefgh# 快餐前台 # 13688889999 ",
  4. "316500011# abcdefgh# 快餐前台 # 13688889999 "
  5. ],
  6. "no":[
  7. "316500012 # abcdefgh # 快餐前台 # 13688889999 (错误:识别码不正确)"
  8. ]
  9. }

错误:

  1. {
  2. "msg":"参数错误 : 该帐号未注册.",
  3. "code":-2,
  4. "data":null
  5. }

打印订单

功能描述:

发送用户需要打印的订单内容给炜煌云小票打印机

请求URL:

https://www.weihuang.cn/api/open/sendMsg

请求方式:

POST(推荐),GET

特别注意:

开发者自己写的请求以表单方式提交数据,请求头需要使用Content-Type: application/x-www-form-urlencoded,请勿使用其它方式提交数据

请求参数:
参数名 是否必须 类型 说明
user 必须 string 炜煌云后台注册用户名。
timestamp 必须 string 当前UNIX时间戳,10位,精确到秒。
sign 必须 string 对参数 user+UKEY+timestamp拼接后(+号表示连接符)进行SHA1加密得到签名,值为40位小写字符串。
sn 必须 string 打印机编号
content 必须 string 打印内容,不能超过5000字节
times string 打印次数,默认为1。

排版控制标签说明

  1. <BR> :换行符
  2. <LOGO> :打印LOGO指令(前提是预先在机器内置LOGO图片)
  3. <PLUGIN> :钱箱或者外置音响指令
  4. <CB></CB>:居中放大
  5. <B></B>:放大一倍
  6. <C></C>:居中
  7. <L></L>:字体变高一倍
  8. <W></W>:字体变宽一倍
  9. <QR></QR>:二维码(单个订单,可以打印多个二维码)
  10. <RIGHT></RIGHT>:右对齐
  11. <BOLD></BOLD>:字体加粗
  12. <BAR_W></BAR_W>:设置一维条形码宽度
  13. <BAR_H></BAR_H>:设置一维条形码高度
  14. <BAR_HRI></BAR_HRI>:选择 HRI 字符的打印位置
  15. <UPCA></UPCA>:打印 UPCA 类型条形码
  16. <UPCE></UPCE>:打印 UPCE 类型条形码
  17. <EAN13></EAN13>或<JAN13></JAN13>:打印 EAN13(JAN13)条形码
  18. <EAN8></EAN8>或<JAN8></JAN8>:打印 EAN8(JAN8)条形码
  19. <ITF></ITF>:打印 ITF 类型条形码
  20. <CODABAR></CODABAR>:打印 CODABAR 类型条形码
  21. <CODE39></CODE39>:打印 CODE39 类型条形码
  22. <CODE128></CODE128>:打印 CODE128 类型条形码

返回参数说明:

参数名 类型 说明
data string 正确返回订单ID。

返回示例:

正确:

  1. {
  2. "msg":"ok",
  3. "code":0,
  4. "data":"816501678_20160919184316_1419533539"
  5. }

错误:

  1. {
  2. "msg":"参数错误 : 该帐号未注册.",
  3. "code":-2,
  4. "data":null
  5. }

删除批量打印机

功能描述:

删除批量打印机

请求URL:

https://www.weihuang.cn/api/open/delPrts

请求方式:

POST(推荐),GET

请求参数:
请求参数名 是否必须 类型 说明
user 必须 string 炜煌云后台注册用户名。
timestamp 必须 string 当前UNIX时间戳,10位,精确到秒。
sign 必须 string 对参数 user+UKEY+timestamp拼接后(+号表示连接符)进行SHA1加密得到签名,值为40位小写字符串。
snlist 必须 string 打印机编号,多台打印机请用减号“-”连接起来。

返回参数说明:

参数名 类型 说明
data array 返回1个数组,包含成功和失败的信息,详看示例。

返回示例:

正确:

  1. {"ok":["800000777成功","915500104成功"],"no":["800000777用户UID不匹配"]}

错误:

  1. {
  2. "msg":"参数错误 : 该帐号未注册.",
  3. "code":-2,
  4. "data":null
  5. }


修改打印机信息

功能描述:

修改打印机信息。

请求URL:

https://www.weihuang.cn/api/open/editPrt

请求方式:

POST(推荐),GET

请求参数:
请求参数名 是否必须 类型 说明
user 必须 string 炜煌云后台注册用户名。
timestamp 必须 string 当前UNIX时间戳,10位,精确到秒。
sign 必须 string 对参数 user+UKEY+timestamp拼接后(+号表示连接符)进行SHA1加密得到签名,值为40位小写字符串。
sn 必须 string 打印机编号
name 必须 string 打印机备注名称
number string 打印机流量卡号码

返回参数说明:

参数名 类型 说明
data bool 正确返回true。

返回示例:

正确:

  1. {
  2. "msg":"ok",
  3. "code":0,
  4. "data":true
  5. }

错误:

  1. {
  2. "msg":"参数错误 : 时间格式不正确。",
  3. "code":1001,
  4. "data":null
  5. }

清空待打印队列

功能描述:

修改打印机信息。

请求URL:

https://www.weihuang.cn/api/open/clearPrt

请求方式:

POST(推荐),GET

请求参数:
请求参数名 是否必须 类型 说明
user 必须 string 炜煌云后台注册用户名。
timestamp 必须 string 当前UNIX时间戳,10位,精确到秒。
sign 必须 string 对参数 user+UKEY+timestamp拼接后(+号表示连接符)进行SHA1加密得到签名,值为40位小写字符串。
sn 必须 string 打印机编号

返回参数说明:

参数名 类型 说明
data bool 正确返回true。

返回示例:

正确:

  1. {
  2. "msg":"ok",
  3. "code":0,
  4. "data":true
  5. }

错误:

  1. {
  2. "msg":"参数错误 : 时间格式不正确。",
  3. "code":1001,
  4. "data":null
  5. }

查询订单是否打印成功

功能描述:

根据订单编号查询订单是否打印成功,订单编号由“打印订单”接口返回

请求URL:

https://www.weihuang.cn/api/open/queryOrderState

请求方式:

POST(推荐),GET

请求参数:
请求参数名 是否必须 类型 说明
user 必须 string 炜煌云后台注册用户名。
timestamp 必须 string 当前UNIX时间戳,10位,精确到秒。
sign 必须 string 对参数 user+UKEY+timestamp拼接后(+号表示连接符)进行SHA1加密得到签名,值为40位小写字符串。
orderid 必须 string 订单编号,由“打印订单”接口返回

返回参数说明:

参数名 类型 说明
data bool 已打印返回true,未打印返回false。

返回示例:

正确:

  1. {
  2. "msg":"ok",
  3. "code":0,
  4. "data":true
  5. }

错误:

  1. {
  2. "msg":"参数错误 : 该帐号未注册.",
  3. "code":-2,
  4. "data":null
  5. }

查询指定打印机某天的订单统计数

功能描述:

查询指定打印机某天的订单详情,返回已打印订单数和等待打印数。

请求URL:

https://www.weihuang.cn/api/open/queryOrderInfoByDate

请求方式:

POST(推荐),GET

请求参数:
请求参数名 是否必须 类型 说明
user 必须 string 炜煌云后台注册用户名。
timestamp 必须 string 当前UNIX时间戳,10位,精确到秒。
sign 必须 string 对参数 user+UKEY+timestamp拼接后(+号表示连接符)进行SHA1加密得到签名,值为40位小写字符串。
sn 必须 string 打印机编号
date 必须 string 查询日期,格式YY-MM-DD,如:2016-09-20

返回参数说明:

参数名 类型 说明
data array 返回已打印订单数和等待打印数。

返回示例:

正确:

  1. {
  2. "msg":"ok",
  3. "code":0,
  4. "data":{"print":6,"waiting":1},
  5. }

错误:

  1. {
  2. "msg":"参数错误 : 时间格式不正确。",
  3. "code":1001,
  4. "data":null
  5. }

获取某台打印机状态

功能描述:

查询指定打印机状态,返回该打印机在线或离线,正常或异常的信息。

请求URL:

https://www.weihuang.cn/api/open/queryPrtStatus

请求方式:

POST(推荐),GET

请求参数:
请求参数名 是否必须 类型 说明
user 必须 string 炜煌云后台注册用户名。
timestamp 必须 string 当前UNIX时间戳,10位,精确到秒。
sign 必须 string 对参数 user+UKEY+timestamp拼接后(+号表示连接符)进行SHA1加密得到签名,值为40位小写字符串。
sn 必须 string 打印机编号

返回参数说明:

参数名 类型 说明
data string 返回打印机状态信息。共三种:
1、离线。
2、在线,工作状态正常。
3、在线,工作状态不正常。
备注:异常一般是无纸,离线的判断是打印机与服务器失去联系超过2分钟。

返回示例:

正确:

  1. {
  2. "msg":"ok",
  3. "code":0,
  4. "data":"在线,工作状态正常"
  5. }

错误:

  1. {
  2. "msg":"参数错误 : 时间格式不正确。",
  3. "code":1001,
  4. "data":null
  5. }

SDK下载

炜煌云API-PHP版

点击下载

炜煌云API-JAVA版

点击下载

炜煌云API-C#版

点击下载

炜煌云API-微信小程序版

点击下载

炜煌云API-NodeJS版

点击下载

炜煌云API-Python版

点击下载

炜煌云API-GO版

点击下载

炜煌云API-Ruby版

点击下载

如有其他技术问题,请拨打公司客服电话400-666-6868

驱动与支持

P14打印驱动
便携POS标签机技术文档
IOS测试工具SDK
WIN系统设置工具
安卓测试工具SDK
炜煌驱动2019(XP-Win10)
炜煌驱动2019兼容旧版(XP-Win10)
POS版本打印机编程手册
炜煌云打印接口测试.apk
如有其他技术问题,请拨打公司客服电话400-666-6868

返回状态码说明

状态 返回码 返回 msg 字段信息 编码解析
成功 0 ok
失败 -1 参数名不能为空
失败 -2 参数值不能传空字符
失败 -3 该帐号未注册
失败 -4 请求时间失效 时间戳和标准时间相差太大
失败 -5 签名错误 请参考请求公共参数 sign 字段说明
失败 -6 打印失败,打印内容超过 5000 字节
失败 -7 打印机编号和用户不匹配

开发常见问题

1、炜煌云打印系统是免费的吗
是的,购买打印机即可免费使用云打印系统,不收额外服务费
2、打印机单行打印多少个字符
58mm的机器,一行打印16个汉字,32个字母;80mm的机器,一行打印24个汉字,48个字母
3、打印机字体有多少种
常用分正常,倍高,倍宽,放大一倍(倍高倍宽)4种,具体可以查看api中的标签
4、如何排版对齐名称,价格等
程序判断名称的占用的字节数,然后补空格对齐
5、炜煌云打印机要一直通着电吗?
不用一直插着电源通着电,店铺休息的时候,关机拔掉电源线,再次使用的时候正常通电开机即可
6、二维码的大小和位置是否可以调整
大小不能调整,根据内容的长度,动态生成,位置固定是最底部居中
7、打印完订单的状态是实时更新的吗
不是,服务器有5秒的缓存,就是说打印完的订单,5秒后才能查询到状态更新

打印机常见问题

1、炜煌云打印机打印字迹不清晰?
请更换较好的热敏纸测试一下,如果还有问题,请检查热敏打印头是否有污渍或灰尘等,关闭电源后可使用棉棒沾98%浓度的酒精轻轻清理干净,待酒精完全蒸发后再通电开机使用
2、网络云打印机需要碳粉、墨水吗?
网络云打印机属于热敏类型打印机,无碳粉或墨水,耗材只需购买相应的热敏打印纸即可,58mm和80mm云打印机使用的是纸宽分别为58mm和80mm的热敏卷纸。
3、无线打印机掉线了,订单会漏吗
由于网络异常情况导致打印机掉线,打印机程序4分钟左右会自动重连,订单是缓存在服务器上面的,机器重连上会继续打印
4、打印订单的时候,刚好没纸了,会漏打吗
不会,重新装上纸后,等几秒后,会补打一份
5、机器出现问题如何保修?
先电话咨询客服,确认故障,非人为因素 整机终身保修、打印头1年免费保修。
产品中心
P16云打印
P15云打印
Kiosk/票据打印机
POS/平台式打印机
移动打印机
面板打印机
关于我们
公司简介
联系我们
留言反馈
联系我们
邮箱: sales@whkj.com.cn
电话:400-666-6868
客户满意中心电话:0769-81196868
周一至周六8:30-18:00(仅收市话费)
地址:东莞市寮步镇仁居路1号松湖智谷研发中心1期A2-801
关注微信公众号
Copyright © Brightek 2019.All right reserved.Powered by Brightek 粤ICP备20003186号