QRCodeTransfer

管理するキャンペーンアセット向けのQRコードAPI

ワークスペースの権限やプラン上限を守りながら、アセットの作成、リンク先の変更、レポートの取得ができます。

APIトークンを取得
Markdownで表示
requests.post(
  'https://qrcodetransfer.com/api/v1/workspaces/ID/assets',
  headers={'Authorization': 'Bearer YOUR_KEY'},
  json=data,
  timeout=10
)
QRコードの例

DOC概要

ワークスペースに属するQRコード、短縮リンク、ページ、フォーム、GS1リンクを中心に作業を構築できます。APIにもユーザーセンターと同じ所有権確認、入力検証、利用枠が適用されます。一括処理を自動化する前に、1件のテストアセットから始めてください。

ベースURL

https://qrcodetransfer.com/api/v1/

データは非公開です。リクエストごとにワークスペースとユーザー・APIキーの権限を確認します。

AUTH認証

対応プランではAPIキーを作成し、サーバーに保存してください。各キーは一つのワークスペースに属し、読み取り・書き込み権限を持ちます。

Authorization: Bearer YOUR_API_KEY

QRQRコード

動的コードはリンク先を更新しても印刷アドレスを維持します。静的コードは内容を直接記録し、リンク先を変更できません。

POST /api/v1/workspaces/WORKSPACE_ID/assets

{
  "kind": "QRCODE",
  "name": "Spring campaign",
  "payload": {
    "type": "LINK",
    "url": "https://example.com/campaign",
    "dynamic": true
  }
}

PDFPDF用コード

PDFを先にアップロードし、ファイルIDでQRコードを作成します。更新までは旧版も利用可能です。非公開ファイルは認証付きダウンロードが必要です。

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 } }

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/publish

FORMフォーム

各回答は公開時の項目定義を保持します。項目IDで回答を送信し、冪等キーで重複を防ぎます。終了後もページは残り、新規回答を停止します。

POST /api/public/forms/FORM_SLUG/submissions
{ "answers": { "email": "[email protected]" },
  "idempotencyKey": "submission-unique-id" }

GS1GS1 Digital Link

商品コードのURIにはAI識別子を含みます。印刷前に検証してください。リンク先変更でも商品識別は維持されます。販売・包装工程で最終コードを確認してください。

POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "GS1", "name": "Product", "payload": {
  "identifierType": "01", "identifierValue": "09506000134369",
  "destinationUrl": "https://example.com/product"
} }

BULK一括作成

一括作成前に各行を確認します。無効なURLや予約済みパスを表示します。同じ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連携

同じAPIキーでHTTP MCPに接続します。JSON対応のステートレスAPIは一覧、取得、作成、更新、分析の5ツールを提供し、書き込み権限が必要です。ホスト型クライアントと直接認証は確認中です。

POST /api/mcp
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{ "jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {} }
ヘルプ