帮助文档

一物一码标签制作API

功能描述

草料提供一物一码标签制作API接口,该API接口可用于对接内部系统,批量生成产品标签、出入凭证、人员卡等。

大致流程:

1、你可以在草料标签样式库中,选择标签样式,按需求进行修改;

2、将设置好的样式保存到账号下,获取样式 ID 参数;

3、按照指定格式拼出对应的 URL;

4、调用时再根据需求传入不同的参数内容, 即可批量生成不同的标签图片。

  • Beta期间 开通API 的用户可长期免费调用;

  • API调用根据IP秒级并发60次,如需更高并发次数,可 前往社区反馈

调用示例

示例URL:

https://open-api.cli.im/cli-open-platform-service/v1/labelStyle/create?cliT=B574&cliD=测试内容&return_file=&theme_color=&cliF1=人员实名信息卡&cliF2=XXX建筑有限公司&cliF3=姓名:张三&cliF4=编号:2389883&cliF5=班组:设备科&cliF6=工种:维修人员&cliF7=入场时间:2022-8-12

请求方法:GET

请求参数

参数名称

是否必须

类型

说明

cliT

 string

标签样式id,例如D10

cliD

 string

二维码动态内容

api_key

 string

用户账号api key

sign

 string

签名,生成方式见加签方式

return_file

 string

返回类型,不传时返回二进制图片流,base64-返回base64编码

cliF,cliP

 string

根据我的样式需要传入的动态字段,cliF表示普通文本字段,cliP表示图片字段,图片需要公网可访问静态地址,按照字段展示顺序排列,例如我的样式有4个字段,第二个为图片字段,其余为文本字段,传入参数为:

cliF1=xx&cliP2=xx&cliF3=xx&cliF4=xx

请求与返回示例

当 return_file 未传时,返回下面图片二进制流

当 return_file=base64 时,返回下面图片的base64编码

file

API调用文档

调用我的样式

可调用自己账号下保存好的标签样式,在后台-「标签样式」目录下选择之前保存的我的标签样式,进入标签样式详情页,点击「更多」-「开通标签API」,开启调用。

对接文档:我的样式API对接文档

file

调用公共样式

也可直接调用草料标签样式库中的公共样式。在标签样式库中,选择一个标签,直接获取标签ID,或者进入样式详情页,点击开通标签制作API。

对接文档:公共样式API对接文档

file

调用案例

由第三方开发者Ryan Cui基于一物一码标签API开发的「草料二维码」插件,已经在飞书多维表格中提供。

通过「草料二维码」插件,用户可以在飞书多维表格中直接选择标签样式,匹配表中字段,将会自动调用草料二维码的一物一码标签API,批量生成不同内容的二维码标签。

了解详情

file