打印模板管理
-
打印模板主要是为定长、定宽的打印内容设计的内容格式化功能,主要用于[标签类打印机ZH-3080](http://www.feyin.cn/zh-3080/ "标签类打印机ZH-3080"),一般根据标签纸张的大小(30mmX40mm、60mmX30mm等多种规格)确定模板外框大小后,再设计内部的内容排版格式。
- 每个开发者名下最多可以创建1000个模板。
模板管理分为如下几个api 1. 创建标签打印模板 2. 修改打印模板 3. 获取模板列表
模板的排版问题请参考:模板格式说明
<h4 id="1">创建标签打印模板</h4>
请求URL:
https://api.open.feyin.net/template?access_token=ACCESS_TOKEN
请求方式:
- POST,JSON提交
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
name | 是 | string | 模板名称,不超过30个字符 |
content | 是 | string | 模板内容,格式详见下面的“模板格式”中的例子 |
catalog | 是 | string | 模板归类,如 "tsc" |
desc | 否 | string | 模板说明 |
请求示例
{
"name": "My Order Template",
"content": "模板的内容,详见下面的例子,譬如 hello {{ name }}",
"catalog": "tsc",
"desc": "模板的消息描述内容"
}
返回示例
正常情况下,飞印开放平台会返回下述JSON数据:
{
"template_id":"bbbbbf0eb8222228c6c5254000bbbbb"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
template_id | string | 返回创建成功的模板id |
错误时飞印开放平台会返回错误码等信息,JSON数据详见“[全局返回码说明](https://www.showdoc.cc/1687352?page_id=82683529162250 "全局返回码说明")”
<h4 id="2">修改打印模板</h4>
请求URL:
https://api.open.feyin.net/template/{template_id}?access_token=ACCESS_TOKEN
- url中的 模板id 为创建模板时,系统返回的模板id
请求方式:
- POST,JSON提交
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
name | 否 | string | 模板名称,不超过30个字符 |
content | 否 | string | 模板内容,格式详见创建模板时的“模板格式”中的例子 |
catalog | 否 | string | 模板归类,如 "tsc" |
desc | 否 | string | 模板说明 |
请求示例
{
"name": "更新过的模板名称",
"content": "需要更新的模板的内容"
"catalog": "tsc",
"desc": "模板的消息描述内容"
}
返回示例
{
"errcode":0,
"errmsg":"ok"
}
JSON数据详见“[全局返回码说明](https://www.showdoc.cc/1687352?page_id=137418124005771 "全局返回码说明")”
<h4 id="3">获取指定的打印模板</h4>
请求URL:
https://api.open.feyin.net/template/detail/{template_id}?access_token=ACCESS_TOKEN
请求方式:
-
GET
返回示例
{
"name": "My Order Template1",
"content": "模板的内容,详见下面的例子,譬如 hello {{ name }}",
"catalog": "tsc",
"desc": "模板的消息描述内容",
"updated_at": "2017-12-20 15:00:00"
}
返回参数说明
返回一个template 对象
tempalte对象
参数名 | 类型 | 说明 |
---|---|---|
name | string | 模板名称 |
content | string | 模板内容 |
catalog | string | 模板归类,如 "tsc" |
desc | string | 模板说明 |
updated_at | string | 模板最后更新时间 |
<h4 id="3">获取所有打印模板列表</h4>
请求URL:
https://api.open.feyin.net/templates?access_token=ACCESS_TOKEN
请求方式:
-
GET
返回示例
[
{
"name": "My Order Template1",
"content": "模板的内容,详见下面的例子,譬如 hello {{ name }}",
"catalog": "tsc",
"desc": "模板的消息描述内容",
"updated_at": "2017-12-20 15:00:00"
},
{
"name": "Tag Template2",
"content": "SIZE 60 mm,40 mm\nCLS\nTEXT 144,30,\"TSS24.BF2\",0,2,2,\"{{text1}}\"",
"catalog": "tsc",
"desc": "商标标签模板",
"updated_at": "2018-01-02 15:00:00"
}
...
]
返回参数说明
返回一个列表,列表中每个元素均为一个如下的template 对象
tempalte对象
参数名 | 类型 | 说明 |
---|---|---|
name | string | 模板名称 |
content | string | 模板内容 |
catalog | string | 模板归类,如 "tsc" |
desc | string | 模板说明 |
updated_at | string | 模板最后更新时间 |
<h3 id="4">模板格式说明</h3>
模板内容中,用 {{ paramNname }} 表示 此处作为参数占位符,在打印模板消息时,将用提交过来的paramName所指定的数据替换,譬如, 假设模板是
TEXT 144,30,"TSS24.BF2",0,2,2,"{{text1}}"
打印模板消息时,传递过来的参数是
{
...
"text1":"这里是替换的内容",
...
}
那么最终打印的内容会是
TEXT 144,30,"TSS24.BF2",0,2,2,"这里是替换的内容"
例1
SIZE 60 mm,40 mm
CLS
TEXT 144,30,"TSS24.BF2",0,2,2,"{{text1}}"
TEXT 70,100,"TSS24.BF2",0,1,2,"{{text2}}"
TEXT 70,180,"TSS24.BF2",0,1,2,"{{text3}}"
TEXT 268,250,"TSS24.BF2",0,1,1,"官方网站"
TEXT 108,285,"TSS24.BF2",0,1,1,"{{text4}}"
QRCODE 240,90,M,6,A,0,"{{qrcode}}"
PRINT 1
例2
SIZE 60 mm,40 mm
CLS
TEXT 144,30,"TSS24.BF2",0,2,2,"{{text1}}"
TEXT 100,100,"TSS24.BF2",0,1,1,"{{text2}}"
TEXT 100,140,"TSS24.BF2",0,1,1,"{{text3}}"
BARCODE 100,230,"128",50,1,0,2,4,"{{barcode1}}"
BAR 100,85,280,5
TEXT 20,17,"TSS24.BF2",0,2,2,"{{text4}}"
TEXT 20,95,"TSS24.BF2",0,2,2,"{{text5}}"
TEXT 20,173,"TSS24.BF2",0,2,2,"{{text6}}"
TEXT 20,251,"TSS24.BF2",0,2,2,"{{text7}}"
TEXT 412,17,"TSS24.BF2",0,2,2,"{{text8}}"
TEXT 412,95,"TSS24.BF2",0,2,2,"{{text9}}"
TEXT 412,173,"TSS24.BF2",0,2,2,"{{text10}}"
TEXT 412,251,"TSS24.BF2",0,2,2,"{{text11}}"
PRINT 1