飞印API参考手册
飞印API是基于web的应用程序接口。您的网站/业务系统是通过 国际W3C标准的HTTP通信协议 发送信息到飞印API并输出到飞印无线打印机的。本章节介绍飞印提供的所有应用程序接口、方法以及对应的参数。
飞印API返回内容分为两种类型:第一种是直接返回一个整型,用来表示调用的结果;第二种是返回XML格式的字符串查询结果。
具体而言,飞印API支持您的网站/业务系统用以下方式调用飞印无线打印机,
- 发送数据到飞印打印机打印输出
- 查询打印任务状态(例如:队列中、已打印)
- 查询打印机工作状态(例如:在线、离线、缺纸等)
- 查询打印异常信息
API基本工作流程
对飞印API的每个调用流程都分为以下2个步骤:
调用请求的鉴权
- 您的网站/业务系统每次调用飞印API都针对发送到信息生成一个MD5的hash字串,将此字串赋值给 securityCode 这一必填变量并发送给飞印API。
- 飞印API根据收到的 securityCode 以及客户代码、 API密钥等信息验证请求的合法性和有效性。
请求的处理
- 对于通过成功鉴权的请求,飞印API将根据调用的方法进行对应的处理/计算。
- 对于未通过成功鉴权的请求,飞印API将拒绝并返回异常信息。
必填参数
所有飞印API请求都必须包含以下参数:
reqTime :请求(发生)时间戳,数值型
本次API请求发生的时刻,值为自 1970-1-1 0:0 到现在的 毫秒数 ,类似于Java语言中的 System.currentTimeMillis() 函数的取值。
securityCode :安全校验码,字符串
调用飞印API的网站/应用系统用 API_KEY 针对请求内容生成的MD5哈希字串,此字串将被飞印API用于请求有效性的验证。 请参考 使用前的准备 了解如何获取 API_KEY 。
memberCode :商户编码,数值型
您在 飞印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录飞印中心按指引获取。