API 文档

二维码生成 / 二维码解码 / 条形码生成 / 解码

注意
以下为对外接口(前缀:/api/v1/*)。
如对接时提示未加白名单或需要 API Key,请联系站点管理员处理。

1) 二维码生成

POST /api/v1/qrcode
参数
字段 类型 必填 说明
content string 二维码内容(文本/URL 等)
size int 尺寸,范围 100-800,默认 300
margin int 边距,范围 0-50,默认 10
foreColor string 前景色(6位 HEX),默认 000000
backColor string 背景色(6位 HEX),默认 FFFFFF
save int 0(默认)返回图片;1 返回 JSON,包含 data.image(base64 DataURL)
返回
默认:直接返回图片。
save=1:返回 JSON,包含 data.image(base64 DataURL)。
{ "code": 1, "msg": "生成成功", "data": { "image": "data:image/png;base64,iVBORw0KGgo..." } }
示例请求
GET {站点域名}/api/v1/qrcode?content=Hello&size=300&margin=10

2) 二维码解码(识别图片)

POST /api/v1/qrcodeDecode
参数
字段 类型 必填 说明
file file 二选一 单个文件字段
files[] / files file[] 二选一 多个文件字段(批量识别)
关于上传文件
该接口仅用于识别二维码内容,上传文件不会被持久化存储。
返回
JSON:data 为数组,每项包含文件名、是否成功、识别内容。
{ "code": 1, "msg": "解码完成", "data": [ { "filename": "qrcode.png", "success": true, "content": "https://example.com" } ] }
示例请求
POST {站点域名}/api/v1/qrcodeDecode Content-Type: multipart/form-data form-data: file: (上传图片文件)

3) 条形码生成

POST /api/v1/barcode
字段说明
字段 类型 必填 说明
content string 条形码内容
type string 条形码类型(例如:TYPE_CODE_128TYPE_EAN_13 等)
width int 条形宽度,默认 2
height int 条形码高度,默认 100
showText bool 是否在条形码下方渲染内容文字(默认 false)
save int 0(默认)返回图片;1 返回 JSON,包含 data.image(base64 DataURL)
返回
默认:直接返回图片。
save=1:返回 JSON,data.image 为 base64 DataURL。
失败:返回 JSON(例如:{"code":0,"msg":"..."})。
示例请求
POST {站点域名}/api/v1/barcode Content-Type: application/json { "content": "123456789", "type": "TYPE_CODE_128" }

4) 解码器(识别图片)

POST /api/v1/decodes
参数
字段 类型 必填 说明
file file 二选一 单个文件字段
files[] / files file[] 二选一 多个文件字段(批量识别)
关于上传文件
该接口基于 zbar 识别图片中的条码(可识别二维码/条形码),上传文件不会被持久化存储。
返回
JSON:data 为数组,每项包含文件名、是否成功、识别内容。
{ "code": 1, "msg": "解码完成", "data": [ { "filename": "barcode.png", "success": true, "content": "1234567890" } ] }
示例请求
POST {站点域名}/api/v1/decodes Content-Type: multipart/form-data form-data: file: (上传图片文件)