
开发者接入API步骤如下,如对接遇到问题,请进入技术支持QQ群咨询:

第一步:入驻成为开发者
首先填写申请表单成为开放平台开发者,点击注册 (美达罗捷API开放平台) 填写对应的信息。勾选同意美达罗捷开放平台开发协议,注册成为会员。
第二步:创建应用
系统会在接收到申请后,进行审核,审核通过后注册即生效,用户可登录后,获取应用开发专属appKey。
查看ApiKey: 登录系统后->开放平台->API信息,即可看到ApiKey。
第三步:接口开发
应用申请通过之后,即可进行应用开发。请认真阅读 API文档进行开发使用。
其中,必接接口是打印必须对接的接口,其他可根据需求是否进行对接。
地址设置要求满足两点:
1.请求推送地址填写必须以https://开头的地址。
2.提交请求参数请采用application/x-www-form-urlencoded方式。
如果有其他技术问题,可以联系美达罗捷技术支持,获取帮助。
美达罗捷API平台地址: https://api.bjguntong.com; 仅接受https连接方式
在请求头设置数据传输格式为: application/x-www-form-urlencoded
所有请求包含三个固定必传参数:
字段名 | 说明 |
---|---|
mobilePhone | 申请AppKey时注册的联系人手机号 |
timestamp | 当前时间戳,以ms为单位 |
sign | 签名(注) |
注:
请使用 mobilePhone + apiKey + timestamp 拼接成字符串,然后进行MD5加密。apiKey为商户首次申请注册后由美达罗捷提供的开发者秘钥,用来进行API调用。加密后获得的32位字符串就是sign(签名)。
功能描述:
在系统中添加打印机。
添加规则:
传入参数:
字段名 | 说明 | 是否必填 |
---|---|---|
mobilePhone | 申请AppKey时注册的联系人手机号 | 是 |
timestamp | 当前时间戳,以ms为单位 | 是 |
sign | 签名(注) | 是 |
type | 打印机类型:1:wifi打印机;3:4G(gprs)打印机;5:二合一打印机。默认为1。 | 是 |
wifiSn | 打印机的wifi网卡序列号 | 否 |
gprsSn | 打印机的4G(gprs)网卡序列号 | 否 |
name | 打印机名称 | 是 |
返回参数:
字段名 | 类型 | 说明 |
---|---|---|
code | Integer | 返回代码。成功:200。其他是失败。 |
data | Object | 返回内容 |
macSn | String | 生成的打印机mac序列号 |
success | boolean | 是否成功。成功:true,失败:false。 |
msg | String | 返回消息 |
功能描述:
传入参数:
字段名 | 说明 | 是否必填 |
---|---|---|
mobilePhone | 申请AppKey时注册的联系人手机号 | 是 |
timestamp | 当前时间戳,以ms为单位 | 是 |
sign | 签名(注) | 是 |
macSn | 打印机的mac序列号 | 是 |
content | 经过排版后的打印内容(字符串)(注) | 是 |
language | 打印的语言选择(1:中文;2:外文。默认不填该选项,就是中文) | 否 |
copy | 打印份数(默认不填就是1份) | 否 |
打印排版格式说明:
<Content></Content> : 内容根节点,所有打印内容必须包含在<Content>内;
<BR></BR>: 新起一行。每行内容需包含在<BR>内;
<CB></CB>: 居中放大;
<B></B>:字体放大;
<C></C>:居中;
<L></L>:字体变高;
<W></W>:字体变宽;
<RIGHT></RIGHT>:右对齐;
<BOLD></BOLD>:字体加粗;
<QRCODE></QRCODE>:打印二维码;
<CODE128></CODE128>:打印条形码;(采用Code128编码)
打印内容示例:
String test = "<content>";
test += "<BR>这是一个测试</BR>";
test += "<BR>中间有字<BOLD>变粗</BOLD>正常</BR>";
test += "<BR>这行<CB>是</CB>纯文<RIGHT>字</RIGHT></BR>";
test += "<BR>这行既要<B>变高又变宽</B>,看看效果</BR>";
test += “<QRCODE>abcdefghijklmn</QRCODE>”;
test += "</content>";
注意:以下是系统保留字符,如需要在内容中使用,请替换成其他合法字符。
< | 小于号 |
> | 大于号 |
& | 和号 |
' | 单引号 |
" | 双引号 |
返回参数:
字段名 | 类型 | 说明 |
---|---|---|
code | Integer | 返回代码。成功:200。其他是失败。 |
data | String | 订单ID号 |
success | boolean | 是否成功。成功:true,失败:false。 |
msg | String | 返回消息 |
功能描述:
打印客户的取消订单内容
打印规则:
传入参数:
字段名 | 说明 | 是否必填 |
---|---|---|
mobilePhone | 申请AppKey时注册的联系人手机号 | 是 |
timestamp | 当前时间戳,以ms为单位 | 是 |
sign | 签名(注) | 是 |
macSn | 打印机的mac序列号 | 是 |
content | 经过排版后的打印内容(字符串)(注) | 是 |
language | 打印的语言选择(1:中文;2:外文。默认不填该选项,就是中文) | 否 |
返回参数:
字段名 | 类型 | 说明 |
---|---|---|
code | Integer | 返回代码。成功:200。其他是失败。 |
data | String | 订单ID号 |
success | boolean | 是否成功。成功:true,失败:false。 |
msg | String | 返回消息 |
功能描述:
获取打印机当前状态
状态描述:
传入参数:
字段名 | 说明 | 是否必填 |
---|---|---|
mobilePhone | 申请AppKey时注册的联系人手机号 | 是 |
timestamp | 当前时间戳,以ms为单位 | 是 |
sign | 签名(注) | 是 |
macSn | 打印机的mac序列号 | 是 |
返回参数:
字段名 | 类型 | 说明 |
---|---|---|
code | Integer | 返回代码。成功:200。其他是失败。 |
data | String | 返回视图类 |
status | Integer | 打印机状态(注) |
statusText | String | 打印机状态文字说明 |
success | boolean | 是否成功。成功:true,失败:false。 |
msg | String | 返回消息 |
注:Status说明:
数字代表状态信息:0:打印机离线; 1:打印机wifi在线; 3:打印机gprs(4G)在线;5:打印机wifi 和 gprs(4G)都在线;
功能描述:
获取该商户下所有打印机当前状态。
方法说明:
传入参数:
字段名 | 说明 | 是否必填 |
---|---|---|
mobilePhone | 申请AppKey时注册的联系人手机号 | 是 |
timestamp | 当前时间戳,以ms为单位 | 是 |
sign | 签名(注) | 是 |
返回参数:
字段名 | 类型 | 说明 |
---|---|---|
code | Integer | 返回代码。成功:200。其他是失败。 |
data | Array | 打印机数组 |
macSn | String | 打印机的macSn |
status | Integer | 打印机状态(注) |
statusText | String | 打印机状态文字说明 |
success | boolean | 是否成功。成功:true,失败:false。 |
msg | String | 返回消息 |
注:Status说明:
数字代表状态信息:0:打印机离线; 1:打印机wifi在线; 3:打印机gprs(4G)在线;5:打印机wifi 和 gprs(4G)都在线;
功能描述:
从系统中删除指定打印机。
方法说明:
传入参数:
字段名 | 说明 | 是否必填 |
---|---|---|
mobilePhone | 申请AppKey时注册的联系人手机号 | 是 |
timestamp | 当前时间戳,以ms为单位 | 是 |
sign | 签名(注) | 是 |
macSn | 打印机的mac序列号 | 是 |
返回参数:
字段名 | 类型 | 说明 |
---|---|---|
code | Integer | 返回代码。成功:200。其他是失败。 |
data | Object | 返回内容 |
success | boolean | 是否成功。成功:true,失败:false。 |
msg | String | 返回消息 |