API接入说明
工作流程:
1、调用请求的鉴权:
您的网站/业务系统每次调用佳博云打印API都针对发送到信息生成一个MD5的hash字串,将此字串赋值给
securityCode 这一必填变量并发送给佳博云打印API。佳博云打印API根据收到的 securityCode
以及客户代码、 API密钥等信息验证请求的合法性和有效性。
2、请求的处理 :
对于通过成功鉴权的请求,佳博云打印API将根据调用的方法进行对应的处理/计算。
对于未通过成功鉴权的请求,佳博云打印API将拒绝并返回异常信息。
授权机制:
1、每一个注册账户将获得一个唯一的商户编码和一个 API密钥。商户编码和 API密钥是使用佳博云打印机的凭证,请妥善保管。
2、商户编码标识对应的账户,调用 API 时商户编码作为必需参数发送到 API 入口地址。
3、API密钥不在网络上传输,调用 API 时用 API密钥和规定的参数进行 MD5 运算,并把结果做为参数发送到 API
入口地址。
4、服务器接收到数据后,首先根据商户编码查找到对应的 API密钥,并对接收的参数进行和客户端一样的
MD5 运算,如果 MD5 结果一致鉴权完成,否则丢弃收到的数据。
佳博云打印API是基于web的应用程序接口。您的网站/业务系统是通过 国际W3C标准的HTTP通信协议 发送信息到佳博云打印API并输出到佳博云打印机的。
第一步:注册开发者账号
到 http://cp.poscom.cn/ (以下统称‘佳博云平台’)注册开发者账号,获得API密钥、商户编码,API密钥和商户编码是开发者API接入的重要身份识别参数。
第二步:对接API
- 01、发送数据到打印机: 发送数据到 WEB API 并通过打印机打印出来。
- 02、查询打印任务状态: 查询打印任务状态的状态。
- 03、查询打印机列表: 检查账户下的所有的佳博云打印机,并返回状态信息。
- 04、添加打印机: 添加打印机至账号(分组)下。
- 05、查询打印机信息: 查询账号下已添加的打印机信息。
- 06、修改打印机信息: 修改账号下打印机设备信息。
- 07、删除打印机: 删除账号下打印机设备。
- 08、打印机wifi设置: 指定打印机下发设置wifi事件。
- 09、取消打印订单: 删除账号下已发送的或正在打印的订单。
- 10、获取打印机状态: 获取单台或多台打印机状态。
- 11、设置logo: 设置打印机NVLogo。
- 12、取消logo: 删除打印机设置的NVLogo。
- 13、打印机设置音量: 指定打印机设置语音音量大小。
特别声明、
1、返回结果皆为json格式数据。
2、特别注意:开发者自己写的请求以表单方式提交数据,请求头需要使用Content-Type
: application/x-www-form-urlencoded,
开发者接入:
开发者在佳博云平台「 https://cp.poscom.cn/ 」 注册账号并登录「已有账号的可以直接登录」,可以使用自主授权模式引导拥有打印机设备的商户对其授权,授权成功后,开发者拥有对终端商户设备的部分处理权限。
1、查询客户名下所有打印机列表
2、查询某一台打印机状态
3、发送打印订单到打印机
4、查询订单打印结果
授权流程
如何获取授权URL
开发者在电脑端使用浏览器登录佳博云平台https://cp.poscom.cn ,在「系统集成」–>「Api集成」中可以看到开发者唯一的授权链接和取消授权链,如图:
注意:授权url和取消授权url均可通过添加state参数,参数值会在回调URL作为state参数返回
如:http://cp.poscom.cn/frontmanage/openoauth/authorize?code=C9D50D3A57666B64106D662C0962E52E&state=gainscha
如何集成授权URL
1) 获取到授权URL并加带上业务参数后http://cp.poscom.cn/frontmanage/openoauth/authorize?code=C9D50D3A57666B64106D662C0962E52E&state=gainscha ,可以直接通过内嵌/弹窗的方式打开授权登陆页;
2) 商户登录成功后,确认授权;
3) 授权成功,关闭页面或回退。
如何设置回调URL
开发者在电脑端使用浏览器登录佳博云平台https://cp.poscom.cn ,在【系统集成】–>【Api集成】中可以设置开发者名称和回调URL,回调URL支持https和http。
回调参数如下:
type,类型(1-授权,2-取消授权)
token,令牌,一个开发者一个商户对应一个唯一的token,永久有效,建议持久化保存
state,透传的业务参数
发送数据到打印机
功能描述:
发送数据到 WEB API 并通过打印机打印出来。
请求地址:
https://api.poscom.cn/apisc/sendMsg
请求方式:
POST
请求头:
Content-Type:application/x-www-form-urlencoded
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。结果字符为小写。 mode=2 与 mode=3 时参与 MD5 运算的参数和顺序: memberCode+deviceID+msgNo(如果存在)+reqTime+apiKey。 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
deviceID | 必须 | string | 佳博云打印机的终端编号。添加终端后,可以在“佳博云打印中心”看到终端的设备编号。 |
mode | 必须 | string | 打印信息的格式类型。取值范围[2-3] mode=2,自由格式打印(推荐使用) mode=3,十六进制命令集或十六进制字符串打印 (无空格,如十六进制 0x12 0xAB 0xCD 0xEF,发送内容 12ABCDEF) |
msgDetail | 必须 | string | 打印信息的内容。 票据机: 票据云打印机格式说明、票据云打印机格式编辑预览,自由打印的格式由用户决定,换行或空格等全部用户自行控制。 一维条码标签:<gpBarCode Type=x Height=y Position=z>内容</gpBarCode> 二维码标签:<gpQRCode>内容</gpQRCode> 标签机:请参考具体机型开发指令或在佳博云管理平台->模板中心->新建模板,可视化编辑生成指令。 |
charset | 可选 | string | 编码格式,取值范围[1-10] 默认1,: 1: GB18030 2: GB2312 3: GBK 4: UTF-8 5: Unicode 6: ISO8859-1 7: BIG5 8: EUC-KR 9: TIS-620 10: VISCII 备注:票据打印机中文默认是 GB18030,标签打印机GP-CH421D,GP-CH422D中文需要设置值为4,表示utf-8。 |
msgNo | 可选 | string | 订单编号。自定义的打印信息编号,可选,一般由用户生成,用于跟踪订单状态。如果没有设置,WEB API 将自动分配。 |
reprint | 可选 | int | 是否重新打印。取值范围[0-1] 0:否,1:是。默认值0。若是重新打印则系统允许 msgNo 字段重复,但不记录订单。 |
multi | 可选 | int | 是否多订单模式。取值范围[0-1] 0:单订单,1:多订单模式,默认 0。 multi设置值1 时开启多订单模式,多订单模式下msgDetail 值为json 格式数据。格式:{"订单编号1":"打印内容1","订单编号2":"打印内容2"}。 注意:订单编号不能重复,建议最大订单数为50 |
times | 可选 | int | 打印联数,取值范围:[1-5],系统默认打印 1 份 |
voice | 可选 | string | 语音内容。仅支持语音版打印机,指令内容请咨询佳博云打印技术人员。 |
token | 可选 | string | 授权token |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
返回代码对照表:
代码值 | 描述 |
---|---|
0 | 正常。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不对。 |
-4 | 安全校验码不正确。 |
-5 | 请求时间失效。 |
-6 | 订单内容格式不对。 |
-7 | 消息号(msgNo)重复。 |
-8 | 消息模式不对。 |
-9 | 服务器错误。 |
-10 | 服务器内部错误。 |
-111 | 使用的佳博云打印机不属于该账户。 |
返回示例:
{"code":0,"msg":"正常"}
查询打印任务状态
功能描述:
查询打印任务状态的状态。
请求地址:
https://api.poscom.cn/apisc/queryState
请求方式:
GET
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey+msgNo 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
msgNo | 必须 | string | 订单编号。 |
token | 可选 | string | 授权token |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
返回代码对照表:
代码值 | 描述 |
---|---|
0 | 打印请求/任务中队列中,等待打印。 |
1 | 打印任务已完成,请求数据已打印。 |
2 | 打印任务失败,请求数据打印失败。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-5 | 请求时间失效。请求时间和请求到达 WEB API 的时间长超出安全范围,请参考“集成前的准备”了解同步应用服务器时间。 |
-6 | 订单编号错误或不存在。 |
返回示例:
{"code":1,"msg":"打印任务已完成,请求数据已打印。"}
查询打印机列表
功能描述:
检查账户下的所有的佳博云打印机,并返回状态信息。
请求地址:
https://api.poscom.cn/apisc/listDevice
请求方式:
POST
请求头:
Content-Type:application/x-www-form-urlencoded
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
token | 可选 | string | 授权token |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
deviceList | array | 打印机列表。 |
id | string | 编号。 |
deviceID | string | 终端编号。 |
imsi | string | 终端编号。 |
title | string | 名称。 |
status | string | 状态说明。 |
返回代码对照表:
代码值 | 描述 |
---|---|
1 | 查询成功。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-5 | 请求时间失效。请求时间和请求到达 WEB API 的时间长超出安全范围,请参考“集成前的准备”了解同步应用服务器时间。 |
返回示例:
{
"code": 1,
"msg":
"查询成功",
"deviceList": [{
"id": "10086",
"imsi":
"2154654512312312",
"title":
"1 号演示机",
"status": "正常"
}, {
"id": "10088",
"imsi": "2154654512312888",
"title": "2 号演示机",
"status": "离线"
}]
}
添加打印机
功能描述:
添加打印机至账号(分组)下。
请求地址:
https://api.poscom.cn/apisc/adddev
请求方式:
POST
请求头:
Content-Type:application/x-www-form-urlencoded
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey+deviceID 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
deviceID | 必须 | string | 终端编号。 |
devName | 必须 | string | 设备名称。 |
grpID | 可选 | int | 分组 ID 。 |
mPhone | 可选 | string | 管理员电话。 |
nPhone | 可选 | string | 通知电话。 |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
返回代码对照表:
代码值 | 描述 |
---|---|
1 | 添加成功。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-5 | 设备编号不存在。 |
返回示例:
{"code":1, "msg":"添加成功"}
查询打印机信息
功能描述:
查询账号下已添加的打印机信息。
请求地址:
https://api.poscom.cn/apisc/device
请求方式:
GET
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey+deviceID 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
deviceID | 必须 | string | 终端编号。 |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
devInfo | Object | 设备信息。 |
deviceID | string | 终端编号。 |
devName | string | 设备名称。 |
mPhone | string | 管理员电话。 |
nPhone | string | 通知电话。 |
返回代码对照表:
代码值 | 描述 |
---|---|
1 | 查询成功。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-5 | 设备编号不存在。 |
返回示例:
{
"code": 1,
"msg":
"查询成功",
"devInfo": {
"deviceID": " 22452342342342342",
"devName": "测试打印机",
"mPhone": "1008611",
"nPhone": "13928888887",
"cutting": 1
}
}
修改打印机信息
功能描述:
修改账号下打印机设备信息。
请求地址:
https://api.poscom.cn/apisc/editdev
请求方式:
POST
请求头:
Content-Type:application/x-www-form-urlencoded
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey+deviceID 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
deviceID | 必须 | string | 终端编号。 |
devName | 必须 | string | 设备名称。 |
grpID | 可选 | int | 分组 ID 。 |
mPhone | 可选 | string | 管理员电话。 |
nPhone | 可选 | string | 通知电话。 |
cutting | 可选 | int | 自动切纸(1 自动,0 非自动) 。 |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
返回代码对照表:
代码值 | 描述 |
---|---|
1 | 修改成功。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-5 | 设备编号不存在。 |
返回示例:
{"code":1, "msg":"修改成功"}
删除打印机
功能描述:
删除账号下打印机设备。
请求地址:
https://api.poscom.cn/apisc/deldev
请求方式:
POST
请求头:
Content-Type:application/x-www-form-urlencoded
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey+deviceID 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
deviceID | 必须 | string | 终端编号。 |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
返回代码对照表:
代码值 | 描述 |
---|---|
1 | 修改成功。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-5 | 设备编号不存在。 |
返回示例:
{"code":1, "msg":"删除成功。"}
取消打印订单
功能描述:
删除账号下已发送的或正在打印的订单。
请求地址:
https://api.poscom.cn/apisc/cancelPrint
请求方式:
POST
请求头:
Content-Type:application/x-www-form-urlencoded
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey+deviceID 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
deviceID | 必须 | string | 终端编号。 |
all | 必须 | int | 是否全部清理,取值范围[0-1]1:是;0:否。默认 0 。 |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
返回代码对照表:
代码值 | 描述 |
---|---|
1 | 修改成功。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-5 | 设备编号不存在。 |
返回示例:
{"code":1, "msg":"取消打印订单成功。"}
获取打印机状态
功能描述:
获取单台或多台打印机状态。
请求地址:
https://api.poscom.cn/apisc/getStatus
请求方式:
POST
请求头:
Content-Type:application/x-www-form-urlencoded
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
deviceID | 必须 | string | 设备 ID,不提交该字段查询用户所有设备。 |
token | 可选 | string | 授权token |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
statusList | object | 状态列表。 |
deviceID | string | 设备 ID。 |
online | int | 在线状态。 |
status | int | 打印机状态。 |
outtime | string | 最近一次离线时间。 |
printnum | int | 累计打印次数。 |
返回在线状态代码值对照表:
代码值 | 描述 |
---|---|
0 | 离线。 |
1 | 在线。 |
返回打印机状态代码值对照表:
代码值 | 描述 |
---|---|
0 | 上线。 |
1 | 正常。 |
2 | 缺纸。 |
3 | 其他异常。 |
4 | 过热。 |
5 | 开盖。 |
8 | 暂停。 |
9 | 打印中。 |
返回代码对照表:
代码值 | 描述 |
---|---|
1 | 修改成功。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-5 | 设备编号不存在。 |
返回示例:
{
"code": 1,
"msg":
"查询成功",
"statusList": [{
"deviceID": "20180629000000096",
"online": 1,
"status": 1,
"outtime": "",
"printnum": 0
}]
}
设置logo
功能描述:
设置打印机NVLogo
请求地址:
https://api.poscom.cn/apisc/setLogo
请求方式:
POST
请求头:
Content-Type:application/x-www-form-urlencoded
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey+deviceID 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
deviceID | 必须 | string | 终端编号。 |
imgUrl | 必须 | string | 图片地址。 设置LOGO 说明 1、logo 图片地址需可访问,图片格式为jpg,png,gif,图片最佳效果是白底黑色图 2、logo 打印结果可能与原图有出入 3、图片宽度最大为280px 4、设置成功后,mode=2 格式下设置打印内容包含<gpLogo/> 会打印LOGO。 5、只适用于票据打印机。设置成功打印机会发出一声“滴” |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
返回代码对照表:
代码值 | 描述 |
---|---|
3 | 设备离线。 |
2 | 设备异常或暂停,恢复正常后可设置。 |
0 | 正常。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-5 | 请求时间失效。请求时间和请求到达WEB API的时间长超出安全范围,请参考“集成前的准备”了解同步应用服务器时间。 |
-6 | 未绑定打印机 |
-11 | 图片宽度过大或数据获取失败 |
设置LOGO说明
1、logo图片地址需可访问,图片格式为jpg,png,gif,图片最佳效果是白底黑色图
2、logo打印结果可能与原图有出入
3、图片宽度最大为280px
4、设置成功后,mode=2格式下设置打印内容包含
5、只适用于票据打印机。设置成功打印机会发出一声“滴”
返回示例:
{"code":1, "msg":"正常。"}
取消logo
功能描述:
删除打印机设置的NVLogo
请求地址:
https://api.poscom.cn/apisc/deleteLogo
请求方式:
POST
请求头:
Content-Type:application/x-www-form-urlencoded
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey+deviceID 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
deviceID | 必须 | string | 终端编号。 |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
返回代码对照表:
代码值 | 描述 |
---|---|
3 | 设备离线。 |
2 | 设备异常或暂停,恢复正常后可设置。 |
0 | 正常。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-5 | 请求时间失效。请求时间和请求到达WEB API的时间长超出安全范围,请参考“集成前的准备”了解同步应用服务器时间。 |
-6 | 未绑定打印机 |
-11 | 图片宽度过大或数据获取失败 |
取消LOGO说明
只适用于票据打印机。
返回示例:
{"code":1, "msg":"正常。"}
打印机设置音量
功能描述:
指定打印机设置语音音量大小
请求地址:
https://api.poscom.cn/apisc/sendVolume
请求方式:
POST
请求头:
Content-Type:application/x-www-form-urlencoded
请求参数:
请求参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
reqTime | 必须 | string | 当前UNIX时间戳。13位,精确到毫秒。 |
securityCode | 必须 | string | 安全校验码。用 API 密钥和规定的参数进行 MD5 运算的结果。 参与 MD5 运算的参数和顺序是: memberCode+reqTime+apiKey+deviceID 所有字符串合并后进行 MD5 运算,即 MD5(合并后字符串) |
memberCode | 必须 | string | 商户编码。您在 佳博云打印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录佳博云打印平台按指引获取。 |
deviceID | 必须 | string | 终端编号。 |
volume | 必须 | int | 音量大小。取值范围 0-100,建议(0,25,50,75, 85,100)。 |
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回代码。 |
msg | string | 返回说明。 |
返回代码对照表:
代码值 | 描述 |
---|---|
3 | 设备离线。 |
2 | 设备异常或暂停,恢复正常后可设置。 |
0 | 设置成功。 |
-1 | IP 地址不允许。 |
-2 | 关键参数为空或请求方式不对。 |
-3 | 客户编码不正确。 |
-4 | 安全校验码不正确。 |
-6 | 未绑定打印机 |
-9 | 设备不在线 |
打印机设置音量
只适用于内置喇叭的打印机。
返回示例:
{"code":0, "msg":"设置成功。"}
平台操作问题 更多
答:
A. 小票机:可能打印内容过少,请尝试发送多点内容;
B. TD2270:可能发送的指令不对,检查指令是否为TSPL。
答:
请检查发送的打印指令是否正确。
如果您的是票据打印机,请尝试发送更长的内容,可能因为内容过少以至于打印的内容还在打印机出纸口内并未有走出来,导致于打印机没有动作的现象。
如果您的是标签打印机:标签打印机需要发送对应的指令内容才能正常打印,请检查发送的内容是否符合和完整。
答:
先检查打印机终端编号是否正确,再检查网络。
外卖店铺授权问题 更多
答:
针对美团的个别订单出现了漏单的问题,经技术人员排查后的原因及解决方法如下:
A. 导致漏单的原因:
用户在电脑的美团外卖商家版客户端「开启了自动接单」;
B. 解决漏单的方法:
请自行登录电脑的美团外卖商家版客户端检查是否开启了「自动接单」;如有,请自行关闭,即可避免漏单的问题;
答:
尝试上下滑动后在点击确定。
答:
直接联系佳博云打印技术客服,电话:0756-3965100。
打印机联网/掉线问题 更多
答:
打开切刀上盖,用细长的工具拨动切刀齿轮,将卡住的切刀拨动回位即可。
答:
打开盖子,检查打印头是否因为使用周期长造成的劳损,如果发现有问题,可直接连接销售或售后客服。
答:
A. GPRS机型,先打印信息页,信息页上显示信号强度为「获取中」或者低于30%,说明使用地无GPRS信号,建议更换个地方放打印机或者更换其他联网方式的打印机,例如WIFI的。
B. 如果信息页显示都正常,打印机也没有响声,麻烦打印信息页,然后核对终端编号和云平台上填写的是否一致,如不一致请删除后重新添加。
问:
商家常见问题 更多
目前获取打印机终端编号有两种途径,根据打印机型号来区分。
58票据系列、GP-305T、GP-TD2270、S-4262、S-4342、EVA G等型号的打印机开机联网成功后,短按(3秒内)打印机的后置按键,打印机会自动打印出一张小票,即可在小票内容中找到“终端编号”信息。
CH-421D、G3-350V型号的打印机,在打印机底部的标签上找到一串17位的纯数字,该数字就是打印机的“终端编号”。
CH-421D、G3-350V型号的打印机,插好网线(网线能自动分配IP并且正常上网)后开机大概40秒左右就会自动获取网络并且连接上云平台,获取的网络IP地址可以通过打印自检页查看,如发现未能正确获取IP地址时,请尝试检查网线并且重启打印机。
检查打印机是否开机并且正常联网;
检查终端编号是否填写正确;
尝试刷新打印机状态。
云打印技术对接问题 更多
答:
①调用4.17 获取打印机状态接口,判断打印机状态;
②调用4.1发送数据到打印机接口,发送订单进行打印;
③如需获取打印任务状态,可过一段时间后(建议5S以上,视打印内容长度而定)调用4.2 查询打印任务状态,对打印订单状态进行判断。
答:
您需要确认接口域名地址是否填写正确;使用CMD工具ping 域名地址是否能正常解析并通讯。
答:
检查商户编码、API密钥、终端编号、时间戳和订单编号等信息是否正确;如都正确,检查安全校验码运算方式是否有误,如无法解决,请联系销售或技术。
平台操作问题
答:
A. 小票机:可能打印内容过少,请尝试发送多点内容;
B. TD2270:可能发送的指令不对,检查指令是否为TSPL。
答:
请检查发送的打印指令是否正确。
如果您的是票据打印机,请尝试发送更长的内容,可能因为内容过少以至于打印的内容还在打印机出纸口内并未有走出来,导致于打印机没有动作的现象。
如果您的是标签打印机:标签打印机需要发送对应的指令内容才能正常打印,请检查发送的内容是否符合和完整。
答:
先检查打印机终端编号是否正确,再检查网络。
答:
A. 确认机器底部与打印机打印出来的终端编号是否一致?
a. 不一致,重新点扫码功能,扫描信息页上的终端编号二维码(或手动输入)即可;
b. 一致,麻烦拍照打印机打印出来的信息页联系佳博云打印客服:0756-3965100协助解绑;
答:
A. 轻按机器背后黑色小按键(功能键)打印机会打印机会打印一张信息页,上面可以查看打印机终端编号「或者在机器底部标贴上直接查看」。
B. 智能机(GP-CH421D/G3)在机器底部标签上的17位纯数字即是。
答:
登录云平台,在「我的--->设置密码」即可。
外卖店铺授权问题
答:
针对美团的个别订单出现了漏单的问题,经技术人员排查后的原因及解决方法如下:
A. 导致漏单的原因:
用户在电脑的美团外卖商家版客户端「开启了自动接单」;
B. 解决漏单的方法:
请自行登录电脑的美团外卖商家版客户端检查是否开启了「自动接单」;如有,请自行关闭,即可避免漏单的问题;
答:
尝试上下滑动后在点击确定。
答:
直接联系佳博云打印技术客服,电话:0756-3965100。
答:
A. 先确认店铺是否授权成功,在云平台对应的应用店铺列表内查看是否能看到店铺。
B. 检查店铺是否设置了打印机,点击对应的外卖店铺,进入店铺列表查看是否设置对了打印机。
C. 检查打印机是不是离线了?在云平台首页,点击「终端列表」查看打印机状态是否正常。
打印机联网/掉线问题
答:
打开切刀上盖,用细长的工具拨动切刀齿轮,将卡住的切刀拨动回位即可。
答:
打开盖子,检查打印头是否因为使用周期长造成的劳损,如果发现有问题,可直接连接销售或售后客服。
答:
A. GPRS机型,先打印信息页,信息页上显示信号强度为「获取中」或者低于30%,说明使用地无GPRS信号,建议更换个地方放打印机或者更换其他联网方式的打印机,例如WIFI的。
B. 如果信息页显示都正常,打印机也没有响声,麻烦打印信息页,然后核对终端编号和云平台上填写的是否一致,如不一致请删除后重新添加。
问:
答:
A. 先检查打印机是否配网,如未配网,请优先使用微信配网,如微信配网始终不成功后尝试网页配网;
B. 已尝试配网但不成功;
检查WiFi名称和密码是否正确,验证方法:在手机WIFI设置上忘记当前连接的WiFi密码后重输。
检查放置打印机的位置的WiFi信号是否足够,把手机放在打印机处观察WIFI信号是否「满格」。
确认连接的WiFi是否为2.4GHz的,安卓9及以上的安卓手机可于点击当前所连接的WiFi后弹出的页面上看到“频率”参数,安卓9及以下在WiFi详细上查看是否有“连接速度”这项,如有的小于130Mbps的均为2.4Ghz;「注:苹果手机在手机上不能判断」。
C. 其他方法:
a. 尝试换一台手机配置(如有)
b. 把所有设备(光猫、路由器、交换机、打印机、手机)都重启一遍后再尝试配网
c. 尝试一台手机开启热点,使用另一台手机配置WiFi,如正常可排除打印机问题
D. 以上所有均不能解决,请联系卖家提供售后服务。
答:
A. 建议使用网线,需插好网线后开机,如是开机后再开机的请重启后再确认打印机状态;
B. GP-CH421D/G3-350V,打印自检页(关机后按着FEED键开机-等待打印机启动(约30秒)-待打印机打印出内容后再放开FEED键,观察打印机IP地址和Cloud IP是否正确。
a. 正确,检查当前网络是否能正常上网、打印机未被路由器限制
b. 不正确,关机后重新拔插一下
C. GP-CH421D-4G版本,确认所插的SIM卡是否能正常使用;
观察插SIM卡旁边的灯是否在「快闪」,正常使用是「快闪的」;
a. 快闪,在云平台上确认终端编号是否一致;
b. 不闪或慢闪,尝试关机后把SIM卡拔插后重新开始观察
D. 以上所有均不能解决,请联系卖家提供售后服务。
答:
A. 很可能是信号不良引起,建议先先检查信号。
B. 网络环境不好,检查是不是很多设备使用了同一个网络,例如店铺的打印机和客人共用一个WiFi。
商家常见问题
目前获取打印机终端编号有两种途径,根据打印机型号来区分。
58票据系列、GP-305T、GP-TD2270、S-4262、S-4342、EVA G等型号的打印机开机联网成功后,短按(3秒内)打印机的后置按键,打印机会自动打印出一张小票,即可在小票内容中找到“终端编号”信息。
CH-421D、G3-350V型号的打印机,在打印机底部的标签上找到一串17位的纯数字,该数字就是打印机的“终端编号”。
CH-421D、G3-350V型号的打印机,插好网线(网线能自动分配IP并且正常上网)后开机大概40秒左右就会自动获取网络并且连接上云平台,获取的网络IP地址可以通过打印自检页查看,如发现未能正确获取IP地址时,请尝试检查网线并且重启打印机。
检查打印机是否开机并且正常联网;
检查终端编号是否填写正确;
尝试刷新打印机状态。
您需要确认使用的是不是热敏纸;
确认打印纸安装正确,详细纸张安装方向可以参考说明书的纸卷安装部分;
若是CH421D,请确认打印机是否操作过初始化,初始化会清空打印机字体,导致打印空白。
答:
能打印图片,但是需要把图片转成打印机对应的指令才能进行打印,详细佳博云打印技术人员或者让技术人员远程协助操作。
答:
请检查是否打印机设置了使用间隙模式但是实际安装了连续纸;
请检查是否打印机的传感器没有拨到指定的位置;
答:
带DIP开关的机器可以通过拨动2号DIP开关对滴滴声进行关闭;
其他机器可以通过音量调节接口对声量进行调整或者关闭;
答:
在中国大陆可以使用中国移动和中国联通的卡;中国大陆以外的其他地区请先查询当地是否有支持GSM网络的运营商;
答:
国家有一个“村村通”的国家系统工程,在短期内2G网络是不会退网的。
答:
您提交信息后需要登陆您填写的邮箱查看账号激活邮件,点击邮件内的激活链接完成账号激活,否则是没办法登陆的。
答:
终端编号:填写终端编号(17位纯数字);
终端名称:自行随意填写
绑定手机号:可不填;
管理员手机号:可不填;
终端分组:可不选
答:
密码可以到【个人设置】-【修改密码】处进行修改;
API密钥可以联系佳博云打印技术人员协助修改。
答:
GP-CH421D打印机在关机状态下按着打印机上的“FEED”键,然后打开打印机电源开关,等待打印机启动(约40秒),待打印机打印出内容后即可松开“FEED”键。打印自检页过程中可能会出现红灯闪烁,请点按“FEED”键就会继续打印。
G3-350V打印机在关机状态下按着打印机上的“FEED”键,然后打开打印机电源开关,等待打印机启动(约40秒),待打印机发出”滴“一声后松开“FEED”键,打印机就会自动打印出自检页。
GP-CH421D标签云打印机单张最长打印长度为1000mm。
云打印技术对接问题
答:
①调用4.17 获取打印机状态接口,判断打印机状态;
②调用4.1发送数据到打印机接口,发送订单进行打印;
③如需获取打印任务状态,可过一段时间后(建议5S以上,视打印内容长度而定)调用4.2 查询打印任务状态,对打印订单状态进行判断。
答:
您需要确认接口域名地址是否填写正确;使用CMD工具ping 域名地址是否能正常解析并通讯。
答:
检查商户编码、API密钥、终端编号、时间戳和订单编号等信息是否正确;如都正确,检查安全校验码运算方式是否有误,如无法解决,请联系销售或技术。
答:
打印机关机、断电、断网后,如果云平台上仍然判断为“在线”状态时,此时发送的内容会于下次打印机恢复正常后进行打印;
打印机关机、断电、断网后,如果云平台已判断打印机为“离线”状态,此时发送的订单云平台将会不接受,并且返回“打印机离线”消息;
答:
模版打印是我们提供的一项增值服务,由佳博云打印技术提供制作及维护的,用户只需提供样式和需求即可,具体详情可以咨询销售或技术客服。
答:
使用^MN指令进行设置;间隙模式:^MNW,连续模式:^MNN。