接入指引
开发者接入API步骤
第一步:注册开发者账号
到 https://www.weihuang.cn/home/user/login.html (以下统称‘炜煌云后台’)注册开发者账号,获得UKEY,账号和UKEY是开发者API接入的重要身份识别参数。
第二步:对接API
-
1、
【必接】添加打印机到开发者账户(可批量)
注意:打印之前必须添加SN、KEY到开发者账户(查看打印机身标签)开发者可以在炜煌管理后台页面人工添加,或者通过本接口程序添加。
-
2、
【必接】打印订单
- 3、
删除打印机(可批量)
- 4、
修改打印机信息
- 5、
清空待打印队列
- 6、
查询订单是否打印成功
- 7、
查询某台打印机某日订单统计数
- 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个数组,包含成功和失败的信息,详看示例。 |
返回示例:
正确:
{ "ok":[ "316500010# abcdefgh# 快餐前台 # 13688889999 ", "316500011# abcdefgh# 快餐前台 # 13688889999 " ], "no":[ "316500012 # abcdefgh # 快餐前台 # 13688889999 (错误:识别码不正确)" ]}
错误:
{ "msg":"参数错误 : 该帐号未注册.", "code":-2, "data":null}
打印订单
功能描述:
发送用户需要打印的订单内容给炜煌云小票打印机
请求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。 |
排版控制标签说明
- <BR> :换行符
- <LOGO> :打印LOGO指令(前提是预先在机器内置LOGO图片)
- <PLUGIN> :钱箱或者外置音响指令
- <CB></CB>:居中放大
- <B></B>:放大一倍
- <C></C>:居中
- <L></L>:字体变高一倍
- <W></W>:字体变宽一倍
- <QR></QR>:二维码(单个订单,可以打印多个二维码)
- <RIGHT></RIGHT>:右对齐
- <BOLD></BOLD>:字体加粗
- <BAR_W></BAR_W>:设置一维条形码宽度
- <BAR_H></BAR_H>:设置一维条形码高度
- <BAR_HRI></BAR_HRI>:选择 HRI 字符的打印位置
- <UPCA></UPCA>:打印 UPCA 类型条形码
- <UPCE></UPCE>:打印 UPCE 类型条形码
- <EAN13></EAN13>或<JAN13></JAN13>:打印 EAN13(JAN13)条形码
- <EAN8></EAN8>或<JAN8></JAN8>:打印 EAN8(JAN8)条形码
- <ITF></ITF>:打印 ITF 类型条形码
- <CODABAR></CODABAR>:打印 CODABAR 类型条形码
- <CODE39></CODE39>:打印 CODE39 类型条形码
- <CODE128></CODE128>:打印 CODE128 类型条形码
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| data | string | 正确返回订单ID。 |
返回示例:
正确:
{ "msg":"ok", "code":0, "data":"816501678_20160919184316_1419533539" }
错误:
{ "msg":"参数错误 : 该帐号未注册.", "code":-2, "data":null}
删除批量打印机
功能描述:
删除批量打印机
请求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个数组,包含成功和失败的信息,详看示例。 |
返回示例:
正确:
{"ok":["800000777成功","915500104成功"],"no":["800000777用户UID不匹配"]}
错误:
{ "msg":"参数错误 : 该帐号未注册.", "code":-2, "data":null}
修改打印机信息
功能描述:
修改打印机信息。
请求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。 |
返回示例:
正确:
{ "msg":"ok", "code":0, "data":true}
错误:
{ "msg":"参数错误 : 时间格式不正确。", "code":1001, "data":null}
清空待打印队列
功能描述:
修改打印机信息。
请求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。 |
返回示例:
正确:
{ "msg":"ok", "code":0, "data":true }
错误:
{ "msg":"参数错误 : 时间格式不正确。", "code":1001, "data":null}
查询订单是否打印成功
功能描述:
根据订单编号查询订单是否打印成功,订单编号由“打印订单”接口返回
请求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。 |
返回示例:
正确:
{ "msg":"ok", "code":0, "data":true }
错误:
{ "msg":"参数错误 : 该帐号未注册.", "code":-2, "data":null}
查询指定打印机某天的订单统计数
功能描述:
查询指定打印机某天的订单详情,返回已打印订单数和等待打印数。
请求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 | 返回已打印订单数和等待打印数。 |
返回示例:
正确:
{ "msg":"ok", "code":0, "data":{"print":6,"waiting":1}, }
错误:
{ "msg":"参数错误 : 时间格式不正确。", "code":1001, "data":null}
获取某台打印机状态
功能描述:
查询指定打印机状态,返回该打印机在线或离线,正常或异常的信息。
请求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分钟。 |
返回示例:
正确:
{ "msg":"ok", "code":0, "data":"在线,工作状态正常" }
错误:
{ "msg":"参数错误 : 时间格式不正确。", "code":1001, "data":null}
SDK下载
炜煌云API-PHP版
炜煌云API-JAVA版
炜煌云API-C#版
炜煌云API-微信小程序版
炜煌云API-NodeJS版
炜煌云API-Python版
炜煌云API-GO版
炜煌云API-Ruby版
返回状态码说明
| 状态 | 返回码 | 返回 msg 字段信息 | 编码解析 |
|---|---|---|---|
| 成功 | 0 | ok | |
| 失败 | -1 | 参数名不能为空 | |
| 失败 | -2 | 参数值不能传空字符 | |
| 失败 | -3 | 该帐号未注册 | |
| 失败 | -4 | 请求时间失效 | 时间戳和标准时间相差太大 |
| 失败 | -5 | 签名错误 | 请参考请求公共参数 sign 字段说明 |
| 失败 | -6 | 打印失败,打印内容超过 5000 字节 | |
| 失败 | -7 | 打印机编号和用户不匹配 |








