DOC介绍
围绕工作区所属的二维码、短链接、页面、表单和 GS1 链接构建流程。API 与用户中心使用相同的所有权检查、输入校验和额度规则。自动化批次前,先测试一个资产。
基础网址
https://qrcodetransfer.com/api/v1/工作空间数据保持私有,每次请求均验证所属空间以及用户或 API 密钥权限。
AUTH身份认证
套餐包含 API 时,可在用户中心创建密钥并保存在服务器。每个密钥属于一个工作空间,具有读取或写入范围。
Authorization: Bearer YOUR_API_KEYQR二维码
动态二维码修改目标后保留已印刷地址。静态二维码直接编码原始内容,无法修改目标。
POST /api/v1/workspaces/WORKSPACE_ID/assets
{
"kind": "QRCODE",
"name": "Spring campaign",
"payload": {
"type": "LINK",
"url": "https://example.com/campaign",
"dynamic": true
}
}PDFPDF 二维码
先上传 PDF,再通过文件标识创建二维码。新文件上传后旧版本仍可用,直到更新资源。未发布文件须通过工作空间身份认证后下载。
POST /api/v1/workspaces/WORKSPACE_ID/files
Content-Type: multipart/form-data
POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "QRCODE", "name": "Product guide",
"payload": { "type": "PDF", "fileId": 123, "dynamic": true } }LINK短链接
使用 SHORTLINK 类型及 HTTP 或 HTTPS 目标创建短链接。自定义路径可选,移至回收站后路径仍保留。
POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "SHORTLINK", "name": "Product launch",
"payload": { "url": "https://example.com/launch" } }PAGE落地页
页面首先是草稿,添加标题和链接后发布。修改草稿不会改变公开版本,须再次发布才生效。
POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "PAGE", "name": "Our links", "payload": {
"title": "Our links",
"links": [{ "label": "Website", "url": "https://example.com" }]
} }
POST /api/v1/workspaces/WORKSPACE_ID/assets/ASSET_ID/actions/publishFORM表单
每份回复保留发布时的字段定义。使用字段标识提交答案,幂等键让重复提交返回原结果。关闭表单保留页面,但停止接收新回复。
POST /api/public/forms/FORM_SLUG/submissions
{ "answers": { "email": "[email protected]" },
"idempotencyKey": "submission-unique-id" }GS1GS1 数字链接
产品码的 URI 包含应用标识,印刷前须验证。修改目标不改变产品身份。请在零售和包装流程中测试最终二维码。
POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "GS1", "name": "Product", "payload": {
"identifierType": "01", "identifierValue": "09506000134369",
"destinationUrl": "https://example.com/product"
} }BULK批量生成
批量创建前预览每行,检查无效网址和保留路径。重试同一批次时使用相同 Idempotency-Key,避免重复创建成功记录。
POST /api/v1/workspaces/WORKSPACE_ID/bulk/preview
POST /api/v1/workspaces/WORKSPACE_ID/bulk/execute
Idempotency-Key: unique-batch-id
{ "kind": "SHORTLINK", "rows": [
{ "name": "Launch", "url": "https://example.com/launch" }
] }HOOKWebhook
套餐支持时,工作空间所有者可管理 Webhook。事件发送前须启用并配置投递。投递记录显示实际结果,保存端点不代表已发出通知。
HTTP错误和状态
错误包含 code、message 和适用的字段错误。401 表示需有效身份;403 表示权限或功能受限;409 表示状态、版本、路径、额度或幂等冲突;422 表示输入无效;503 表示服务不可用。暂停或封禁的公开码返回 410。
MCPMCP 集成
HTTP MCP 客户端使用同一工作空间 API 密钥。无状态接口支持 JSON 响应以及列出、获取、创建、更新资源和分析五个工具,写工具需写入权限。托管客户端和直接登录仍在验证。
POST /api/mcp
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{ "jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {} }