登录 注册

对对机开放平台API接口说明

当前版本 更新日期 撰写人 说明
V1.0 2016-08-20 Xgl 初版
V2.0 2017-03-24 Xgl 新增提交打印任务2.0版
V3.0 2017-12-07 Xgl 新增网页内容打印
V4.0 2018-05-28 Xgl 新增D2打印接口相关参数,新增D2设备状态和任务结果回调设置,新增查询设备型号

注册成为个人或企业开发者,即可获得AppKey和AppSecret。

注:在接入平台之前,需要完成个人或企业认证,方可调用开放平台相关接口。

如有问题请咨询

对对机开发者Q群:577017132

官方微信:Mstching

官方客服热线:0772-2484099。

接口请求和响应统一使用json格式数据传输,统一为Http Post 请求方式。请求参数说明:在发起请求的时候,请设置Content-Type为:application/json;charset=utf-8,并且需要在url后面拼接以下几个参数

参数名称 参数类型 说明
appid String 平台账户里面的appkey
nonce String 随机字符串(通常为8-10位数字
timestamp String 时间戳(精确到秒
signature String 签名字符串(小写

Signature生成方法为:

appsecret(平台账户后台可获得),timestampnonce 三个参数的值进行字典(正序)排序后拼接在一起,进行sha1加密得到的字符串

请求地址 http(s)://www.open.mstching.com/home/userbind
参数名称 参数类型 说明 备注
请求参数
Uuid String 设备唯一编号(双击设备可获得
UserId String 与对对机平台关联的用户唯一标示(你自己系统定义的)
DeviceName String 设备名称
响应参数
Code Int 响应码 200成功 其他失败
Message String 响应信息描述
OpenUserId Int 对对机平台用户唯一编号
请求地址 http(s)://www.open.mstching.com/home/getdevicestate
参数名称 参数类型 说明 备注
请求参数
Uuid String 设备唯一编号
响应参数
Code Int 响应码 200成功 其他失败
Message String 响应信息描述
State Int 状态值(-1错误 0正常 1缺纸 2温度保护报警 3忙碌 4离线)
请求地址 http(s)://www.open.mstching.com/home/printcontent2
参数名称 参数类型 说明 备注
请求参数
Uuid String 设备唯一编号
PrintContent String 打印内容(json字符串)

格式如:

[{"Alignment":1,"BaseText":"图片的base64编码字符串","Bold":1,"FontSize":1,"PrintType":1},{"Alignment":0,"BaseText":" base64字符串","Bold":0,"FontSize":0,"PrintType":0}]
json内容参数说明详见第四项
OpenUserId Int 对对机平台用户唯一编号 由接口1所得
响应参数
Code Int 响应码 200成功 其他失败
Message String 响应信息
TaskId Long 打印任务编号
请求地址 http(s)://www.open.mstching.com/home/printhtmlcontent
参数名称 参数类型 说明 备注
请求参数
Uuid String 设备唯一编号
PrintUrl String 打印网页地址(需以http://或https://开头) 注:确保网页可以正常访问,且内容不要太大,否则有可能无法打印。网页建议:
1.页面默认字体大小可设置为:24px
2.页面宽度:384px
3.可参考http(s)://www.open.mstching.com/print-demo.html
OpenUserId Int 对对机平台用户唯一编号 由接口1所得
响应参数
Code Int 响应码 200成功 其他失败
Message String 响应信息
TaskId Long 打印任务编号
请求地址 http(s)://www.open.mstching.com/home/getprinttaskstate
参数名称 参数类型 说明 备注
请求参数
TaskId Long 打印任务编号
响应参数
Code Int 响应码 200成功 其他失败
Message String 响应信息
State Int 状态值(0待处理 1成功 2失败 3任务过期 4拒绝打印)
请求地址 http(s)://www.open.mstching.com/home/getdevicemac
参数名称 参数类型 说明 备注
请求参数
Uuid String 设备编号
响应参数
Code Int 响应码 200成功 其他失败
Message String 响应信息
DeviceMac String 设备Mac
请求地址 http(s)://www.open.mstching.com/home/getdevicemodel
参数名称 参数类型 说明 备注
请求参数
Uuid String 设备编号
响应参数
Code Int 响应码 200成功 其他失败
Message String 响应信息
DeviceModel String 设备型号 如:D2
参数名称 参数类型 说明 备注
PrintType Int 打印类型 0文本 1图片 3条码 4二维码
Alignment Int 排版方式 0居左 1居中 2居右
Bold Int 是否加粗 0不加粗 1加粗
FontSize Int 字体大小
取值 字体类型 单行支持汉字/字符数
0 24*24 16/32
1 48*48 8/16
BaseText String 内容的base64字符串 如果printtype=0|3|4 需传文本(gbk)编码的base64字符串,如果printtype=1 需传图片的base64字符串
参数名称 参数类型 说明 备注
PrintType Int 打印类型 0文本 1图片 3条码 4二维码
Alignment Int 排版方式 0居左 1居中 2居右
Bold Int 是否加粗 0不加粗 1加粗
FontSize Int 字体大小
取值 字体类型 单行支持汉字/字符数
0 24*24 16/32
1 24*48 16/32
2 48*24 8/16
3 48*48 8/16
10 16*16 24/48
11 16*32 24/48
12 32*16 12/24
13 32*32 12/24
字体效果点击查看:http://www.mstching.com/home/fontdemo
BaseText String 内容的base64字符串 如果printtype=0|3|4 需传文本(utf-8)编码的base64字符串,如果printtype=1 需传图片的base64字符串

行内实现强制换行,请使用 \n

5.1 请登录http://www.mstching.com/account/login进行设置即可

5.2 设备开机或发生状态变化的时候,都会进行回调通知(每次执行1次)请确保接口正常访问

打印任务结果每次任务进行1次回调通知,请确保接口正常访问

200 成功
1000 服务处理异常
1001 验证签名错误
1002 链接失效
1003 参数错误
1004 AppId不存在
1005 设备不存在
1006 开发者账号已被禁用
1007 任务不存在或权限不足
1008 未通过认证
1009 限制调用
1010 设备未连接
1011 与服务器断开链接
1012 打印任务不能为空