自主授权开发使用说明

一、 总体说明

1. 开发者在佳博云平台「 https://cp.poscom.cn/ 」 注册账号并登录「已有账号的可以直接登录」,可以使用自主授权模式引导拥有打印机设备的商户对其授权,授权成功后,开发者拥有对终端商户设备的部分处理权限,分别是:
  • 查询客户名下所有打印机列表

  • 查询某一台打印机状态

  • 发送打印订单到打印机

  • 查询订单打印结果

二、 授权流程

三、 如何获取授权URL

1. 开发者在电脑端使用浏览器登录佳博云平台https://cp.poscom.cn ,在「系统集成」–>「Api集成」中可以看到开发者唯一的授权链接和取消授权链,如图:


2.注意:授权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

1. 开发者在电脑端使用浏览器登录佳博云平台https://cp.poscom.cn ,在【系统集成】–>【Api集成】中可以设置开发者名称和回调URL,回调URL支持https和http。


2.回调参数如下:
  • type,类型(1-授权,2-取消授权)
  • token,令牌,一个开发者一个商户对应一个唯一的token,永久有效,建议持久化保存
  • state,透传的业务参数

六、发送数据到打印机

1. 请求地址:

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

2.请求方式:

POST

3.请求头:

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

4.请求参数:
请求参数名 必须 类型 说明
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 打印信息的格式类型。mode=2,自由格式打印(推荐使用);mode=3,十六进制命令集或十六进制字符串打印(无空格,如十六进制 0x12 0xAB 0xCD 0xEF,发送内容 12ABCDEF)
msgDetail 必须 string 打印信息的内容。格式化打印的格式请查看“佳博云打印中心”的模板说明,自由打印的格式由用户决定,换行或空格等全部用户自行控制。一维条码标签:内容二维码签:内容
charset 可选 string 参数 mode=1 或 mode=2 时,允许指定打印内容使用编码格式,(不填写)默认 charset=1,支持字符:1: GB18030 2: GB2312 3: GBK 4: UTF-8 5: Unicode 6: ISO8859- 7: BIG5 备注:票据打印机中文默认是 GB18030,标签打印机如 CH421D 中文需要设置为 utf-8。
msgNo 可选 string 订单编号。自定义的打印信息编号,可选,一般由用户生成,用于跟踪订单状态。如果没有设置,WEB API 将自动分配。
reprint 可选 int 是否重新打印。1:是;0:否。若是重新打印则系统允许 msgNo 字段重复
multi 可选 int 是否多订单模式。1:订单模式,0:单个订单,默认 0
times 可选 int 打印联数,取值范围:[ 1 - 5 ],系统默认打印 1 份
voice 可选 string 语音内容。语音只支持特定的打印机,指令内容请咨询佳博云打印技术人员。
token 可选 string 用户自助授权方式的请求token

七、查询打印任务状态

1. 功能描述:

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

2.请求地址:

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

3.请求方式:

GET

4.请求参数:

八、查询打印机列表

1. 功能描述:

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

2.请求地址:

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

3.请求方式:

POST

4.请求头:

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

5.请求参数:

九、获取打印机状态

1. 功能描述:

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

2.请求地址:

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

3.请求方式:

POST

4.请求头:

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

5.请求参数:

文档更新时间: 2020-09-08 17:14   作者:佳博云打印