发送打印数据

本节介绍飞印API最重要的功能,发送数据到飞印API并通过飞印打印机输出打印,以及对应的返回状态码。

API功能端点

http://my.feyin.net/api/sendMsg

支持的打印格式

通过飞印API发送的信息内容支持2种格式:

  1. 自由格式(自定义格式)的文本信息,需根据业务需要自行调整打印输出格式
  2. 格式化信息(例如客户订单)

如果选择格式化信息,您必须根据飞印中心或 飞印API集成示例代码 提供的例子来需要打印输出的数据和格式。

API调用方法

发送打印数据的飞印API请求以及参数应该用 HTTP POST 方法发送。飞印API将根据收到的信息验证请求的有效性反馈对应的状态码。

必填参数

发送打印数据的飞印请求必须包含以下参数(必填参数用 粗体 标识)。每个有效的飞印API请求必须必须包含必填参数:

reqTime :请求(发生)时间戳,数值型

本次API请求发生的时刻,值为自 1970-1-1 0:0 到现在的 毫秒数 类似于Java语言中的 System.currentTimeMillis() 函数的取值。

securityCode :安全校验码,字符串

调用飞印API的网站/应用系统用 API_KEY 针对请求内容生成的MD5哈希字串,此字串将被飞印API用于请求有效性的验证。 请参考 使用前的准备 了解如何获取 API_KEY 。

memberCode :商户编码,数值型

您在 飞印中心 注册的帐号对应的(系统自动生成的)商户编码,可登录飞印中心按指引获取。

deviceNo :飞印打印机的设备编码,字符串

打印请求将发送到对应此设备编码的飞印无线打印机。可在 飞印中心 “我的终端”中获取已注册到飞印中心的飞印打印机设备编码,也可通过以下方式直接从打印机本身获取:按一下通电中的飞印打印机背面黑色小按钮,即可打印出一张测试页面,其中包含本机设备编码。

mode :发送打印信息的格式类型,数值型

  1. 表示格式化信息,
  2. 表示自由格式(自定义格式)信息。这种方法方便您灵活配置和测试打印信息格式,开发时建议通过一台测试机测试实际打印效果,直到获得满意的输出信息格式化效果。

msgDetail :打印的数据/信息内容,字符串

对于 mode=1 的信息,打印输出的数据将按以下方式排版:

  订单项名称 1@单价 1@数量 1 ||
  订单项名称 2@单价 2@数量 2 ||
  ......||
  订单项名称  x@单价 N@数量 N

mode=2 时,用户可自由设置打印格式,空行或空格等全部由调用程序自行控制。

可选参数

charge :订单总金额,数值型

以 “分” 计算的金额,例如:1元 = 100分。只用于发送格式化信息( mode=1 时)。

customerName :客户名称,字符串

只用于发送格式化信息( mode=1 时)。

customerPhone :客户联系人电话,字符串

只用于发送格式化信息( mode=1 时)。

customerAddress :客户地址,字符串

只用于发送格式化信息( mode=1 时)。

customerMemo :客户留言/备注,字符串

只用于发送格式化信息( mode=1 时)。

msgNo :信息/订单编号,字符串

自定义的打印信息编号,可选,一般由调用网站/应用系统自动生成,用于跟踪订单。如果没有设置,飞印API将给每个打印请求自动分配一个。

返回的状态码

飞印API的打印数据请求的返回信息包含2类:

以整型表示的状态码,表示请求的处理结果

  1. XML格式的字符串信息,表示请求的返回内容/信息
  2. 飞印API将对每个打印请求返回一个状态码。它们的含义如下:

0 :正常

-1 :IP地址不允许

-2 :关键参数为空或请求方式不对

-3 :客户编码不对

-4 :安全校验码不正确

-5 :请求时间失效

-6 :订单内容格式不对

-7 :重复的消息 ( msgNo 的值重复)

-8 :消息模式不对

-9 :服务器错误

-10 :服务器内部错误

-111 :打印终端不属于该账户

results matching ""

    No results matching ""