特别声明：

1、请求URL：
http://api.jp.feieyun.com/Api/Open/
https://api.jp.feieyun.com:443/Api/Open/ (新增)

API接口同时支持http,https两种方式

2、每个请求的参数包含2部分：公共参数和私有参数，详细请看以下对应说明。

3、返回结果皆为json格式数据。

4、以下每个接口只列出私有参数和返回结果的data参数，其他请看请求和返回的公共参数说明。

特别注意：开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/x-www-form-urlencoded，请勿使用其它方式提交数据

5、相关SDK下载 点击查看

请求公共参数说明：

返回公共参数说明

批量添加打印机，Open_printerAddlist

功能描述：

批量添加打印机，请严格参照格式说明：

例如：

    316500010 # abcdefgh # 快餐前台 # 13688889999
    316500011 # abcdefgh # 快餐厨房 # 13688889990

请求URL：

http://api.jp.feieyun.com/Api/Open/

请求方式：

POST(推荐)，GET

公共参数：

私有参数：

返回参数说明：

返回示例：

正确：

{
    "ok":[
        "316500010# abcdefgh# 快餐前台  # 13688889999 ",
        "316500011# abcdefgh# 快餐前台  # 13688889999 "
        ],
    "no":[
        "316500012 # abcdefgh # 快餐前台  # 13688889999  （错误：识别码不正确）"
        ]
}

错误：

{
    "msg":"参数错误 : 该帐号未注册.",
    "ret":-2,
    "data":null,
    "serverExecutedTime":37
}

打印订单，Open_printMsg

功能描述：

发送用户需要打印的订单内容给飞鹅云小票打印机 （该接口只能是小票机使用，如购买标签机请使用标签机专用接口）

请求URL：

http://api.jp.feieyun.com/Api/Open/

请求方式：

POST(推荐)，GET

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/x-www-form-urlencoded，请勿使用其它方式提交数据

公共参数：

私有参数：

排版控制标签说明：(详情请参考SDK示例)

 <BR> ：换行符
 <CUT> ：切刀指令(主动切纸,仅限切刀打印机使用才有效果) 
 <LOGO> ：打印LOGO指令(前提是预先在机器内置LOGO图片)
 <PLUGIN> ：钱箱或者外置音响指令
 <CB></CB>：居中放大
 <B></B>：放大一倍
 <C></C>：居中
 <L></L>：字体变高一倍
 <W></W>：字体变宽一倍
 <QR></QR>：二维码（单个订单，最多只能打印一个二维码）
 <RIGHT></RIGHT>：右对齐
 <BOLD></BOLD>：字体加粗

 说明：条形码标签仅支持以下标签规定的内容打印，如需要打印其它特殊字符条形码，需要点击后面的 飞鹅云条形码函数按钮
 下载条形码函数进行调用打印
 <BC128_A>123ABCDEF</BC128_A>：数字字母混合条形码,最多支持14位数字大写字母混合
 <BC128_C>0123456789</BC128_C>：最多支持22位纯数字
 打印条形码(一维条码)和订单排版对齐，点击下载以下函数参考,如有其它技术问题请加入飞鹅API开放平台5群:  146903613。

 飞鹅云条形码函数  下载   排版对齐函数例子  下载   云打印常用小例子  下载
 

返回参数说明：

返回示例：

正确：

  {
      "msg":"ok",
      "ret":0,
      "data":"816501678_20160919184316_1419533539",
      "serverExecutedTime":3
  }

错误：

{
    "msg":"参数错误 : 该帐号未注册.",
    "ret":-2,
    "data":null,
    "serverExecutedTime":37
}

标签机打印订单，Open_printLabelMsg

功能描述：

发送用户需要打印的订单内容给飞鹅云标签打印机（该接口只能是标签机使用，其它型号打印机请勿使用该接口）

请求URL：

http://api.jp.feieyun.com/Api/Open/

请求方式：

POST(推荐)，GET

特别注意：

1、开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/x-www-form-urlencoded，如需打印图片，请求头需要使用Content-Type: multipart/form-data，请勿使用其它方式提交数据；
2、打印内容内（标签除外）大于号和小于号需要经过转译才能正常打印。其中，“ <”用“&lt;”表示，“>”用“&gt;”表示；
3、1mm=8dots。

公共参数：

私有参数：

排版控制标签说明：

 以下标签里面的x，y值参数说明：
      x，y值需要按照实际使用的纸规格大小取值。例如标签纸大小为：宽40mm，高度为30mm。
      1mm=8dots
      x的最大值就是40*8=320，x的取值范围是0-320。
      y的最大值就是为30*8=240，y的取值范围是0-240。

 <SIZE>width,height</SIZE>：
 设置卷标纸宽高，width 标签纸的宽度(不含背纸)，height 标签纸的高度(不含背纸)，单位mm，如<SIZE>30,20</SIZE> 

 <DIRECTION>n</DIRECTION> ：
 设定打印时出纸和打印字体的方向，n 0 或 1，每次设备重启后都会初始化为 0 值设置，1：正向出纸，0：反向出纸，
 如<DIRECTION>1</DIRECTION> 

 <IMG x="10" y="100">：
 打印图片，需配合上传img图片二进制数据使用（一张订单只能打印一次），其中属性x为水平方向起始点坐标（默认为0），
 属性y为垂直方向起始点坐标（默认为0）

 <QR x="10"  y="100"  e="L"  w="5">二维码内容</QR>：
 打印二维码，其中属性x为水平方向起始点坐标（默认为0），属性y为垂直方向起始点坐标（默认为0），属性e为纠错等级：
 L 7%M 15%Q 25%H 30%（默认为K），属性w为二维码宽度（默认为5）

 <TEXT x="10" y="100" font="12" w="2" h="2" r="0">文本内容</TEXT>：
 打印文本，其中属性x为水平方向起始点坐标（默认为0），属性y为垂直方向起始点坐标（默认为0），属性font为字体：
 1、 8×12 dot 英数字体
 2、 12×20 dot 英数字体
 3、 16×24 dot 英数字体
 4、 24×32 dot 英数字体
 5、 32×48 dot 英数字体
 6、 14×19 dot 英数字体 OCR-B
 7、 21×27 dot 英数字体 OCR-B
 8、 14×25 dot 英数字体 OCR-A
 9、 9×17 dot 英数字体
 10、 12×24 dot 英数字体
 11、 繁体中文 24×24Font(大五码) 
 12、 简体中文 24×24Font(GB 码) 
 13、 韩文 24×24Font(KS 码)

 默认为12 简体中文 24×24Font(GB 码)，属性w为文字宽度放大倍率1-10（默认为1），属性h为文字高度放大倍率1-10
 属性r为文字旋转角度(顺时针方向)：
 0     0度
 90   90度
 180 180度
 270 270度
 （默认为0）

 <BC128 x="10" y="100" h="80" s="1" r="0" n="1" w="1">12345678</BC128>：打印code128一维码，其中属性x为水平
 方向起始点坐标（默认为0），属性y为垂直方向起始点坐标（默认为0），属性s是否人眼可识：0 不可识，1 可识（默认为1），
 属性n为窄 bar 宽度，以点(dot)表示（默认为1），属性w为宽 bar 宽度（默认为1），以点(dot)表示，属性r为文字旋转角度
 (顺时针方向)：
 0     0度
 90   90度
 180 180度
 270 270度
 （默认为0）

 <BC39 x="10" y="100" h="80" s="1" r="0" n="1" w="1">12345678</BC39>：打印code39一维码，其中属性x为水平方向
 起始点坐标（默认为0），属性y为垂直方向起始点坐标（默认为0），属性s是否人眼可识：0 不可识，1 可识（默认为1），属性
 n为窄bar宽度，以点(dot)表示（默认为1），属性w为宽 bar 宽度（默认为2），以点(dot)表示，属性r为文字旋转角度(顺时针
 方向)：
 0     0度
 90   90度
 180 180度
 270 270度
 （默认为0）

 <LOGO x="10" y="100">：打印LOGO指令(前提是预先在机器内置LOGO图片)，其中属性x为水平方向起始点坐标（默认为0），
 属性y为垂直方向起始点坐标（默认为0）
 打印订单效果示例，点击下载以下函数参考,如有其它技术问题请加入飞鹅API开放平台5群:  146903613。

 标签机打印订单例子  下载
 

返回参数说明：

返回示例：

正确：

  {
      "msg":"ok",
      "ret":0,
      "data":"816501678_20160919184316_1419533539",
      "serverExecutedTime":3
  }

错误：

{
    "msg":"参数错误 : 该帐号未注册.",
    "ret":-2,
    "data":null,
    "serverExecutedTime":37
}

删除批量打印机，Open_printerDelList

功能描述：

删除批量打印机

请求URL：

http://api.jp.feieyun.com/Api/Open/

请求方式：

POST(推荐)，GET

公共参数：

私有参数：

返回参数说明：

返回示例：

正确：

  {"ok":["800000777成功","915500104成功"],"no":["800000777用户UID不匹配"]}

错误：

{
    "msg":"参数错误 : 该帐号未注册.",
    "ret":-2,
    "data":null,
    "serverExecutedTime":37
}

修改打印机信息，Open_printerEdit

功能描述：

修改打印机信息。

请求URL：

http://api.jp.feieyun.com/Api/Open/

请求方式：

POST(推荐)，GET

公共参数：

私有参数：

返回参数说明：

返回示例：

正确：

{
    "msg":"ok",
    "ret":0,
    "data":true,
    "serverExecutedTime":9
}

错误：

{
    "msg":"参数错误 : 时间格式不正确。",
    "ret":1001,
    "data":null,
    "serverExecutedTime":37
}

清空待打印队列，Open_delPrinterSqs

功能描述：

修改打印机信息。

请求URL：

http://api.jp.feieyun.com/Api/Open/

请求方式：

POST(推荐)，GET

公共参数：

私有参数：

返回参数说明：

返回示例：

正确：

  {
  "msg":"ok",
  "ret":0,
  "data":true,
  "serverExecutedTime":9
  }

错误：

{
    "msg":"参数错误 : 时间格式不正确。",
    "ret":1001,
    "data":null,
    "serverExecutedTime":37
}

查询订单是否打印成功，Open_queryOrderState

功能描述：

根据订单ID,去查询订单是否打印成功,订单ID由接口Open_printMsg返回

请求URL：

http://api.jp.feieyun.com/Api/Open/

请求方式：

POST(推荐)，GET

公共参数：

私有参数：

返回参数说明：

返回示例：

正确：

  {
      "msg":"ok",
      "ret":0,
      "data":true,
      "serverExecutedTime":2
  }

错误：

{
    "msg":"参数错误 : 该帐号未注册.",
    "ret":-2,
    "data":null,
    "serverExecutedTime":37
}

打印状态回调

1. 订单状态回调场景说明：

接口提供方式
回调接口统一使用https post方式，contentType 为“application/x-www-form-urlencoded”。需要服务商在开发者后台配置回调地址白名单，并在提交打印订单时提交回调地址。

2. 消息格式 ：

2.1 数字签名验证说明

2.1.1 获取待验证签名字符串
获取所有飞鹅云开放平台的 post 内容，不包括字节类型参数，如文件、字节流，剔除 sign 字段，剔除值为空的参数；按照第一个字符的键值 ASCII 码递增排序（字母升序排序），如果遇到相同字符则按照第二个字符的键值 ASCII 码递增排序，以此类推；将排序后的参数与其对应值，组合成 参数=参数值 的格式，并且把这些参数用 & 字符连接起来，此时生成的字符串为待验签字段为，如：
orderId：816501678_20160919184316_1419533539
status：1 stime：1625194910 则待验签字段为：orderId=816501678_20160919184316_1419533539&status=1&stime=1625194910

2.1.2 取出签名值sign
NW1BNm4oTxyyPBdXHPwuI5gjh2onvyHavrSLnrPAGCp4TnoX1IJTwwX+tXFybdi+bo+OM/1FoIeU4H70fPw0m/z/Fz6EYdDpsBbUZFbbUdj9OJrzY/sdnArkynnYoVkLGOwV0DM1WvCn3iqlskD5O1K6POFDc0006xMK+d3/SSNegSUPMuIvuXG6VKGiDN0rO9hOdXFjrp0b1Td14ofPXKibmGXV7XikC2suU45nWmCBC8lKzhazCiInS/tkRAF8WsS2AiACeMvmonyrT/LZWbsfrd9k6M+kATCOz7EjPEd9z+W8N8Rtbur1m3MZdjAshMfduqQEpRU+w7U6R4sxQA==

2.1.3 将签名参数（sign）使用 base64 解码为签名值字节码串

2.1.4 使用飞鹅云公钥、待验证签名字符串、签名值字节码串进行SHA256WithRSA验证签名值是否正确。

2.2 飞鹅云公钥

点击下载附件

3 响应格式

返回示例：

SUCCESS

查询指定打印机某天的订单统计数，Open_queryOrderInfoByDate

功能描述：

查询指定打印机某天的订单详情，返回已打印订单数和等待打印数。

请求URL：

http://api.jp.feieyun.com/Api/Open/

请求方式：

POST(推荐)，GET

公共参数：

私有参数：

返回参数说明：

返回示例：

正确：

  {
  "msg":"ok",
  "ret":0,
  "data":{"print":6,"waiting":1},
  "serverExecutedTime":9
  }

错误：

{
    "msg":"参数错误 : 时间格式不正确。",
    "ret":1001,
    "data":null,
    "serverExecutedTime":37
}

获取某台打印机状态，Open_queryPrinterStatus

功能描述：

查询指定打印机状态，返回该打印机在线或离线，正常或异常的信息。

请求URL：

http://api.jp.feieyun.com/Api/Open/

请求方式：

POST(推荐)，GET

公共参数：

私有参数：

返回参数说明：

返回示例：

正确：

  {
  "msg":"ok",
  "ret":0,
  "data":"在线，工作状态正常",
  "serverExecutedTime":9
  }

错误：

{
    "msg":"参数错误 : 时间格式不正确。",
    "ret":1001,
    "data":null,
    "serverExecutedTime":37
}

公共参数异常

添加打印机接口

打印订单接口

删除打印机接口

修改打印机信息接口

清空待打印队列接口

查询订单是否打印成功接口

查询打印机某天的订单统计数接口

查询打印机状态接口