DOC介紹
圍繞工作區所屬的 QR 碼、短連結、頁面、表單與 GS1 連結建立流程。API 與使用者中心採用相同的擁有權檢查、輸入驗證及額度規則。自動化批次前,先測試一個資產。
基礎網址
https://qrcodetransfer.com/api/v1/工作空間資料保持私有,每次請求均驗證所屬空間以及使用者或 API 金鑰權限。
AUTH身分驗證
方案包含 API 時,可在使用者中心建立金鑰並保存在伺服器。每個金鑰屬於一個工作空間,具有讀取或寫入範圍。
Authorization: Bearer YOUR_API_KEYQRQR 碼
動態 QR Code 修改目的地後保留已列印位址。靜態 QR Code 直接編碼原始內容,無法修改目的地。
POST /api/v1/workspaces/WORKSPACE_ID/assets
{
"kind": "QRCODE",
"name": "Spring campaign",
"payload": {
"type": "LINK",
"url": "https://example.com/campaign",
"dynamic": true
}
}PDFPDF QR Code
先上傳 PDF,再透過檔案識別碼建立 QR Code。新檔案上傳後舊版本仍可用,直到更新資源。未發布檔案須通過工作空間身分驗證後下載。
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 包含應用識別碼,列印前須驗證。修改目的地不改變產品身分。請在零售與包裝流程中測試最終 QR Code。
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": {} }