佳博云打印API是基于web的应用程序接口。您的网站/业务系统是通过 国际W3C标准的HTTP通信协议 发送信息到佳博云打印API并输出到佳博云打印机的。

第一步：注册开发者账号

到 http://cp.poscom.cn/ （以下统称‘佳博云平台’）注册开发者账号，获得API密钥、商户编码，API密钥和商户编码是开发者API接入的重要身份识别参数。

第二步：对接API

1. 01、发送数据到打印机： 发送数据到 WEB API 并通过打印机打印出来。
2. 02、查询打印任务状态： 查询打印任务状态的状态。
3. 03、查询打印机列表： 检查账户下的所有的佳博云打印机，并返回状态信息。
4. 04、查询打印异常信息： 查询打印异常的 API 功能来查询相关异常信息，方便诊断问题和解决问题。
5. 05、添加打印机分组： 添加打印机分组，方便分组管理。
6. 06、查询打印机分组列表： 查询账号下打印机分组列表。
7. 07、修改打印机分组名称： 修改账号下打印机分组名称。
8. 08、删除打印机分组： 删除账号下打印机分组。
9. 09、添加打印机： 添加打印机至账号（分组）下。
10. 10、查询打印机信息： 查询账号下已添加的打印机信息。
11. 11、修改打印机信息： 修改账号下打印机设备信息。
12. 12、删除打印机： 删除账号下打印机设备。
13. 13、指定模板打印： 指定模板编号与模板参数，发送数据到 WEB API 并通过打印机打印出来。
14. 14、打印机wifi设置： 指定打印机下发设置wifi事件。
15. 15、取消打印订单： 删除账号下已发送的或正在打印的订单。
16. 16、打印机暂停设置： 指定打印机下发设置暂停事件。
17. 17、获取打印机状态： 获取单台或多台打印机状态。
18. 18、设置logo： 设置打印机NVLogo。
19. 19、取消logo： 删除打印机设置的NVLogo。
20. 20、打印机设置音量： 指定打印机设置语音音量大小。

特别声明、

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 并通过打印机打印出来。

请求地址:

http://api.poscom.cn/apisc/sendMsg

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":0,"msg":"正常"}

查询打印任务状态

功能描述：

查询打印任务状态的状态。

请求地址:

http://api.poscom.cn/apisc/queryState

请求方式：

GET

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":1,"msg":"打印任务已完成，请求数据已打印。"}

查询打印机列表

功能描述：

检查账户下的所有的佳博云打印机，并返回状态信息。

请求地址:

http://api.poscom.cn/apisc/listDevice

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{
"code": 1,
"msg": "查询成功",
"deviceList": [{
"id": "10086",
"imsi": "2154654512312312",
"title": "1 号演示机",
"status": "正常"
}, {
"id": "10088",
"imsi": "2154654512312888",
"title": "2 号演示机",
"status": "离线"
}]
}

查询打印异常信息

功能描述：

无线移动通信网络故障或停电等外部因素将导致佳博云无线打印机打印失败。WEBAPI 将对失败的打印请求生成异常日志，用户可以用查询打印异常的 API 功能来查询相关异常信息，方便诊断问题和解决问题。

请求地址:

http://api.poscom.cn/apisc/listException

请求方式：

Get

请求参数：

返回参数：

返回代码对照表：

返回示例：

添加打印机分组

功能描述：

添加打印机分组，方便分组管理。

请求地址:

http://api.poscom.cn/apisc/addgroup

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":1, "msg":"添加分组成功", "grpID":123}

查询打印机分组

功能描述：

查询账号下打印机分组列表。

请求地址:

http://api.poscom.cn/apisc/group

请求方式：

GET

请求参数：

返回参数：

返回代码对照表：

返回示例：

{
"code": 1,
"msg": "查询成功",
"grpList": [{
"grpID": 123,
"grpName": "分组 1"
},
{
"grpID": 124,
"grpName": "分组 2"
}
]
}

修改打印机分组名称

功能描述：

修改打印机分组名称。

请求地址:

http://api.poscom.cn/apisc/editgroup

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":1, "msg":"修改成功"}

删除打印机分组

功能描述：

删除打印机分组。

请求地址:

http://api.poscom.cn/apisc/delgroup

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":1, "msg":"删除成功"}

添加打印机

功能描述：

添加打印机至账号（分组）下。

请求地址:

http://api.poscom.cn/apisc/adddev

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":1, "msg":"添加成功"}

查询打印机信息

功能描述：

查询账号下已添加的打印机信息。

请求地址:

http://api.poscom.cn/apisc/device

请求方式：

GET

请求参数：

返回参数：

返回代码对照表：

返回示例：

{
"code": 1,
"msg": "查询成功",
"devInfo": {
"deviceID": " 22452342342342342",
"devName": "测试打印机",
"mPhone": "1008611",
"nPhone": "13928888887",
"cutting": 1
}
}

修改打印机信息

功能描述：

修改账号下打印机设备信息。

请求地址:

http://api.poscom.cn/apisc/editdev

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":1, "msg":"修改成功"}

删除打印机

功能描述：

删除账号下打印机设备。

请求地址:

http://api.poscom.cn/apisc/deldev

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":1, "msg":"删除成功。"}

指定模板打印

功能描述：

指定模板编号与模板参数，发送数据到 WEB API 并通过打印机打印出来。

请求地址:

http://api.poscom.cn/apisc/templetPrint

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":0,"msg":"正常"}

取消打印订单

功能描述：

删除账号下已发送的或正在打印的订单。

请求地址:

http://api.poscom.cn/apisc/cancelPrint

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":1, "msg":"取消打印订单成功。"}

打印机暂停设置

功能描述：

指定打印机下发设置暂停事件 （只对GP-CH421D机型）

请求地址:

http://api.poscom.cn/apisc/setPause

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

返回示例：

{"code":1, "msg":"设置暂停事件发送成功"}

获取打印机状态

功能描述：

获取单台或多台打印机状态。

请求地址:

http://api.poscom.cn/apisc/getStatus

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回在线状态代码值对照表：

返回打印机状态代码值对照表：

返回代码对照表：

返回示例：

{
"code": 1,
"msg": "查询成功",
"statusList": [{
"deviceID": "20180629000000096",
"online": 1,
"status": 1,
"outtime": "",
"printnum": 0
}]
}

设置logo

功能描述：

设置打印机NVLogo

请求地址:

http://api.poscom.cn/apisc/setLogo

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

设置LOGO说明

1、logo图片地址需可访问，图片格式为jpg,png,gif，图片最佳效果是白底黑色图
2、logo打印结果可能与原图有出入
3、图片宽度最大为280px
4、设置成功后，mode=2格式下设置打印内容包含 会打印LOGO。
5、只适用于票据打印机。设置成功打印机会发出一声“滴”

返回示例：

{"code":1, "msg":"正常。"}

取消logo

功能描述：

删除打印机设置的NVLogo

请求地址:

http://api.poscom.cn/apisc/deleteLogo

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

取消LOGO说明

只适用于票据打印机。

返回示例：

{"code":1, "msg":"正常。"}

打印机设置音量

功能描述：

指定打印机设置语音音量大小

请求地址:

http://api.poscom.cn/apisc/sendVolume

请求方式：

POST

请求头：

Content-Type:application/x-www-form-urlencoded

请求参数：

返回参数：

返回代码对照表：

打印机设置音量

只适用于内置喇叭的打印机。

返回示例：

{"code":0, "msg":"设置成功。"}