QRコード更新API
既存のQRコードの設定やデザインを更新するためのAPIです。
URL、テキスト、電話番号に加え、色やスタイル、ロゴなどの各種オプションも変更できます。QRコードを再生成することなく、そのまま内容が更新されます。
QRコードを新しく作成せずに設定のみ変更したい場合に利用します。
PUT
/api/link/v1/update/qr
{
"linkId": "K56t",
"domain": "https://vvd.bz",
"type": "url",
"url": "https://www.instagram.com/vivoldiglobal",
"logoType": "U",
"logo": "https://example.com/images/picture/logo/20260425/500x500.png",
"foreground": "#0269D1FF"
}
Request Parameters
- linkId string required
-
リンクID。
URLが「https://vvd.im/myBrandQR」の場合、リンクIDは
myBrandQRです。 - domain string required
- Default:https://vvd.bz
- リンクドメイン。 カスタムドメインを使用する場合は、ここで指定できます。
- type string
- Default:url
-
Enum:
urltextphone
-
QRコードの種類。
- url: WebページURL
- text: テキスト
- phone: 電話番号
- url string
-
QRコード読み取り時の遷移先URL。
typeがurlの場合は必須で、http または https の完全なURLを入力してください。
最大2,000 bytes。 - text string
-
QRコードに埋め込むテキスト。
typeがtextの場合に使用し、読み取り時にそのまま表示されます。
メッセージやコードなどに活用でき、表示形式はデバイスにより異なる場合があります。
最大65,535 bytes。 - phone string
-
QRコード読み取り時に発信される電話番号。
typeがphoneの場合に使用され、端末の発信画面が開きます。
最大32文字。国番号付きの形式を推奨します。 - logoType string
- Default:N
-
Enum:
NCU
-
QRコード中央に配置するロゴの種類。
- N: ロゴなし
- C: 組織設定のデフォルトロゴ
- U: カスタムロゴ
ロゴを追加するとブランド認知が向上します。
本機能はパーソナルプラン以上で利用可能です。 - logo string
-
QRコード中央に表示するロゴ画像URL。
logoTypeがUの場合に使用します。外部公開されたURLを指定してください。
正方形・透過PNGを推奨。最大サイズは500x500pxです。 - foreground string
-
QRコードの前景色(HEX形式)。デフォルトは黒。
背景とのコントラストを十分に確保してください。
デフォルト: #000000FF - background string
-
QRコードの背景色(HEX形式)。デフォルトは白。
暗すぎる背景は認識率が低下する可能性があります。
デフォルト: #FFFFFFFF - markerColor string
-
位置検出マーカーの色。視覚的に強調可能。
デフォルト: #000000FF - markerBorderColor string
-
マーカーの枠線色。低コントラストは認識に影響します。
デフォルト: #000000FF - style string
- QRコードの全体スタイル。ダッシュボードで確認可能。
- markerStyle string
- マーカーの形状スタイル。複数のデザインをサポート。
- grpIdx integer
- グループ識別子。リンク管理に使用します。
- ttl string
- 内部管理用タイトル。
- memo string
- 内部メモ(ユーザー非表示)。
- qrBypassYn string
-
Y: 直接遷移(トラッキングなし)
N: 短縮リンク経由(トラッキングあり) - pushNotifyYn string
- スキャン時のプッシュ通知設定。
- mailNotifyYn string
- スキャン時のメール通知設定。
- delYmdt datetime
- 削除予約日時。指定時刻後に自動削除。
{
"code": 0,
"message": "",
"result": null
}
Response Parameters
- code integer
- 応答コード: 0 = 成功、それ以外の値 = エラー
- message string
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- result null
このAPIを利用する場面
以下のようなケースでQRコード更新APIを利用します。
- すでに配布済みのQRコードの遷移先URLを変更したい場合
- 色やロゴ、スタイルなどのデザインを更新したい場合
- QRコードを削除せず、内容や設定のみ変更したい場合
- ブランドリニューアルなどでQRコードのデザインをまとめて変更したい場合
印刷物やオフライン素材に掲載済みのQRコードを差し替えることなく内容だけ更新できます。
活用例
QRコード更新APIは、さまざまなシーンで活用できます。
- 印刷物・バナー: 配布済みQRコードの遷移先URLのみ変更し、再印刷コストを削減
- ブランドリニューアル: 新しいブランドカラーに合わせてQRコードのデザインを一括更新
- イベント運用: シーズンに応じて遷移先ページを切り替え
- 店舗・テーブル: メニュー変更時に既存QRコードの遷移先を新しいページへ更新
すでに配布されたQRコードをそのまま活用したい場合に特に有効です。
利用時の注意点
QRコードを更新する際は、以下の点にご注意ください。
-
foreground(前景色)とbackground(背景色)はセットで変更してください。
背景色のみ変更するとコントラスト不足により読み取り精度が低下する可能性があります。 -
backgroundは #FFFFFF(白系)の使用を推奨します。
暗い背景色ではQRコードのパターンが認識されにくくなる場合があります。 typeを変更する場合は、そのタイプに対応するデータパラメータを必ず指定してください。grpIdxでグループを変更すると、QRコードは新しいグループへ移動し、元のグループからは除外されます。