テンプレート

エンジンには厳選されたテンプレート、つまりIDで呼び出せる既製の QrConfig オブジェクトが用意されています。確実に見栄えのよい結果が欲しく、細かく作り込む必要がないときに使ってください。

テンプレートの一覧

GET /api/qr/templates

{
  "success": true,
  "count": 118,
  "templates": [
    {
      "id": "champagne-onyx",
      "name": "Champagne on Onyx",
      "category": "luxury",
      "tags": ["dark", "monogram", "premium"],
      "preview": "https://api.qr-branding.com/api/qr/templates/champagne-onyx/preview"
    },
    { "...": "..." }
  ]
}

カテゴリーで絞り込む

GET /api/qr/templates?category=luxury

レスポンスの形式は絞り込みなしの呼び出しと同じですが、一致したものだけが含まれます。カテゴリーは大文字と小文字を区別せず、各テンプレートの category フィールドと照合されます。最新の一覧は /examples の「テンプレート」タブで確認できます。

テンプレートから生成する

POST /api/qr/templates/{templateId}

ボディは QrConfig のサブセットで、指定した項目はテンプレートのデフォルトを上書きします。ほとんどの呼び出し元が上書きするのは content、outputWidth、fileFormat だけです。

よく使う上書き

フィールド	上書きする理由
`content`	エンコードするURLまたはテキスト — ほぼ必ず上書きします
`outputWidth`	印刷用の解像度（1200、2400、4096）
`fileFormat`	印刷用には `pdf` または `svg`、画面用には `png`
`logoUrl`	どのテンプレートにもロゴを重ねられます
`centerText`	「ADMIT ONE」/「SCAN ME」のようなバナーを追加
`ctaText`	下部のキャプション

ビジュアルギャラリー

すべてのテンプレートを並べてレンダリングしたものは /examples にあります。同じギャラリーは、オフラインで確認できるようビジュアルリファレンスにも同梱されています。