欢迎!这里是飞印API文档

飞印API文档描述、示例


发送打印消息

<p><strong>简要描述:</strong></p> <ul> <li>发送/批量发送打印数据</li> <li>通过飞印API发送的信息内容支持2种格式: <ol> <li>调用方自行组装好消息内容后,发送给飞印</li> <li>模板化信息,指定模板id以及该模板需要的参数内容,由飞印api生成最终的打印消息。</li> </ol></li> </ul> <p><strong>请求URL:</strong></p> <ul> <li><code>https://api.open.feyin.net/msg?access_token=ACCESS_TOKEN</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST,JSON BODY提交</li> </ul> <p><strong>参数:</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">device_no</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>机器编号,如果是批量发送消息,这里每个机器编号用英文逗号','隔开</td> </tr> <tr> <td style="text-align: left;">msg_no</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>第三方系统针对本消息的唯一标示,譬如订单id等业务id,以便消息完成打印回调时能准确定位业务, 如果没有指定,飞印平台会自动生成一个唯一的消息id并通过接口返回</td> </tr> <tr> <td style="text-align: left;">appid</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>开发者在飞印平台创建的第三方应用id,对其他已授权用户的打印机调用时为必选项</td> </tr> <tr> <td style="text-align: left;">msg_content</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>需要打印的消息内容,在非模板消息时需要指定,详见<a href="https://www.showdoc.cc/web/#/feyin?page_id=137570592155865">消息排版说明</a></td> </tr> <tr> <td style="text-align: left;">template_id</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>模板id,仅在打印模板消息时需指定,打印模板消息一般标签打印类(比如ZH-3080)机型比较常用,当然普通飞印票据机型也都支持。</td> </tr> <tr> <td style="text-align: left;">template_data</td> <td style="text-align: left;">否</td> <td style="text-align: left;">json</td> <td>模板数据,非字符串,仅在打印模板消息时需指定</td> </tr> </tbody> </table> <p><strong>请求示例(普通消息)</strong></p> <pre><code class="language-json"> { "device_no": "4600408123456789", "msg_no":"ORDER-201712201500", "msg_content": "这里是需要打印的详细内容" }</code></pre> <p><strong>请求示例(普通消息)批量打印</strong></p> <pre><code class="language-json"> { "device_no": "4600408123456789,4600408123456790", "msg_no":"ORDER-201712201500", "msg_content": "这里是需要打印的详细内容" }</code></pre> <p><strong>请求示例(模板消息)</strong></p> <pre><code class="language-json"> { "device_no": "4600408123456789", "msg_no":"ORDER-201712201500", "template_id": "bbbbbf0eb8222228c6c5254000bbbbb", "template_data": {"text1":"公司名称","text2":"二维码地址" ...} }</code></pre> <p>这里假设模板<em>bbbbbf0eb8222228c6c5254000bbbbb</em> 对应的模板内容,有 {{ text1 }} 和 {{ text2 }} 等占位符</p> <p><strong>返回示例</strong></p> <p>正常情况下,飞印开放平台会返回下述JSON数据:</p> <pre><code class="language-json"> { "msg_no":"ORDER-201712201500", "err_msg":"" }</code></pre> <p><strong>返回参数说明</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">msg_no</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">本次打印消息的唯一标记,如果在api请求时有指定 msg_no, 则此处跟请求时指定的值一样; 如果时未指定,飞印平台会自动生成一个唯一的消息id</td> </tr> <tr> <td style="text-align: left;">errmsg</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td style="text-align: left;">主要针对于批量打印时的出错信息,成功时,这里为空字符串&quot;&quot;</td> </tr> </tbody> </table> <p>错误时飞印开放平台会返回错误码等信息,JSON数据示例如下:</p> <pre><code class="language-json">{ "errcode":10001, "errmsg":"invalid appid" }</code></pre> <p>JSON数据详见“<a href="https://www.showdoc.cc/web/#/feyin?page_id=137418124005771" title="全局返回码说明">全局返回码说明</a>”</p>

页面列表

ITEM_HTML