QR コード

ロゴ、色、スタイル、コンテンツタイプ付きで QR コードを作成し、一覧または更新します。

対応タイプ

type に次のいずれかのキーを渡します。コンテンツ項目はタイプによって変わります。

text
url
phone
sms
email
whatsapp
facetime
location
wifi
event
vcard
crypto
paypal
upi
epc
pix

POST/api/v1/qr-codes

QR コードを作成

リクエスト本文に JSON を送ります。name と type は必須です。url タイプでは url を渡します。スタジオでデザインしたコードに合わせるには style、色、qr_code_logo を追加します。file タイプは API では利用できません。

名前	型	必須	デフォルト	説明
name	string	はい	—	リソースに保存されるラベル。
type	string	はい	url	コンテンツタイプ。対応する QR キーのいずれか（file を除く）。
url	string	いいえ	—	行き先 URL。type が url のとき必須。
text	string	いいえ	—	プレーンテキスト。type が text のとき必須。一括テキストではこの項目で行を分けます。
url_dynamic	boolean	いいえ	false	true の場合、短縮リンクが作られ、QR はそのリンクを符号化するため、あとから行き先を変えられます。
project_id	integer	いいえ	—	リソースを紐づけるプロジェクト。
is_bulk	boolean	いいえ	false	true かつ type が text の場合、text の各行に 1 つの QR が作られます。
style	string	いいえ	square	モジュールの形。例: square、dot、rounded、heart、hexagon。
inner_eye_style	string	いいえ	square	内側ファインダーパターンの形。例: square、dot、circle、rounded。
outer_eye_style	string	いいえ	square	外側ファインダーパターンの形。例: square、circle、rounded、flower。
size	integer	いいえ	500	画像サイズ（ピクセル）、50–2000。
margin	integer	いいえ	0	クワイエットゾーンのモジュール数、0–25。
ecc	string	いいえ	M	誤り訂正: L、M、Q、H。ロゴを入れるときは H を使います。
foreground_type	string	いいえ	color	color または gradient。
foreground_color	string	いいえ	#000000	モジュール色（HEX）。
foreground_gradient_style	string	いいえ	horizontal	vertical、horizontal、diagonal、inverse_diagonal、または radial。
foreground_gradient_one	string	いいえ	—	グラデーションの 1 色目（HEX）。
foreground_gradient_two	string	いいえ	—	グラデーションの 2 色目（HEX）。
background_color	string	いいえ	#ffffff	背景の HEX 色。モジュールより明るくしてください。
background_color_transparency	integer	いいえ	0	背景の透明度、0–100。
custom_eyes_color	boolean	いいえ	false	true の場合、アイは eyes_inner_color と eyes_outer_color を使います。
eyes_inner_color	string	いいえ	#000000	内側アイの HEX 色。
eyes_outer_color	string	いいえ	#000000	外側アイの HEX 色。
qr_code_logo	string	いいえ	—	ロゴ画像の URL またはアップロード済みファイルキー。
qr_code_logo_size	number	いいえ	25	QR に対するロゴサイズ（パーセント）、5–40。
frame	string	いいえ	—	スタジオの任意フレームキー。
frame_text	string	いいえ	—	フレームに描くキャプション。

タイプ別のコンテンツ項目

名前	型	必須	デフォルト	説明
phone	string	いいえ	—	type が phone のときの電話番号。
sms	string	いいえ	—	type が sms のときの電話番号。
sms_body	string	いいえ	—	SMS 本文。
email	string	いいえ	—	type が email のときの宛先。
email_subject	string	いいえ	—	メール件名。
email_body	string	いいえ	—	メール本文。
whatsapp	string	いいえ	—	WhatsApp 番号（数字のみ）。
whatsapp_body	string	いいえ	—	WhatsApp の事前入力テキスト。
wifi_ssid	string	いいえ	—	type が wifi のときのネットワーク名。
wifi_password	string	いいえ	—	Wi-Fi パスワード。
wifi_encryption	string	いいえ	WPA	nopass、WEP、WPA、または WPA/WPA2。
location_latitude	number	いいえ	—	type が location のときの緯度。
location_longitude	number	いいえ	—	type が location のときの経度。
event	string	いいえ	—	type が event のときのイベント名。
event_start_datetime	string	いいえ	—	イベント開始の ISO 日時。
vcard first_name / last_name / email	string	いいえ	—	vCard 項目: first_name、last_name、email、およびその他のスタジオキー。

リクエスト例

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}'

その他の例

グラデーション QR

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Gradient QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "dot",
  "inner_eye_style": "circle",
  "outer_eye_style": "rounded",
  "foreground_type": "gradient",
  "foreground_gradient_style": "radial",
  "foreground_gradient_one": "#5c8b29",
  "foreground_gradient_two": "#25492f",
  "background_color": "#ffffff",
  "size": 600
}'

Wi-Fi QR

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Office Wi-Fi",
  "type": "wifi",
  "wifi_ssid": "Guest",
  "wifi_password": "correct-horse",
  "wifi_encryption": "WPA",
  "style": "square",
  "ecc": "H"
}'

レスポンス例

{
  "data": {
    "id": 1,
    "type": "url",
    "name": "Website QR",
    "qr_code": "https://…/qr-codes/…/qr.svg",
    "settings": {
      "style": "rounded",
      "size": 500,
      "ecc": "M"
    }
  }
}

GET/api/v1/qr-codes

QR コードを一覧

名前	型	必須	説明
page	integer	いいえ	Page number (default 1)
results_per_page	integer	いいえ	Items per page (default 25, max 100)
search	string	いいえ	Search term
search_by	string	いいえ	Column to search
order_by	string	いいえ	Sort column
order_type	string	いいえ	asc or desc
datetime_start	string	いいえ	ISO datetime filter start
datetime_end	string	いいえ	ISO datetime filter end
project_id	integer	いいえ	—
type	string	いいえ	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/v1/qr-codes/{id}

QR コードを 1 件取得

名前	型	必須	説明
id	integer	はい	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/v1/qr-codes/{id}

QR コードを更新

名前	型	必須	デフォルト	説明
id	integer	はい	—	—
name	string	いいえ	—	リソースに保存されるラベル。
type	string	いいえ	url	コンテンツタイプ。対応する QR キーのいずれか（file を除く）。
url	string	いいえ	—	行き先 URL。type が url のとき必須。
text	string	いいえ	—	プレーンテキスト。type が text のとき必須。一括テキストではこの項目で行を分けます。
url_dynamic	boolean	いいえ	false	true の場合、短縮リンクが作られ、QR はそのリンクを符号化するため、あとから行き先を変えられます。
project_id	integer	いいえ	—	リソースを紐づけるプロジェクト。
is_bulk	boolean	いいえ	false	true かつ type が text の場合、text の各行に 1 つの QR が作られます。
style	string	いいえ	square	モジュールの形。例: square、dot、rounded、heart、hexagon。
inner_eye_style	string	いいえ	square	内側ファインダーパターンの形。例: square、dot、circle、rounded。
outer_eye_style	string	いいえ	square	外側ファインダーパターンの形。例: square、circle、rounded、flower。
size	integer	いいえ	500	画像サイズ（ピクセル）、50–2000。
margin	integer	いいえ	0	クワイエットゾーンのモジュール数、0–25。
ecc	string	いいえ	M	誤り訂正: L、M、Q、H。ロゴを入れるときは H を使います。
foreground_type	string	いいえ	color	color または gradient。
foreground_color	string	いいえ	#000000	モジュール色（HEX）。
foreground_gradient_style	string	いいえ	horizontal	vertical、horizontal、diagonal、inverse_diagonal、または radial。
foreground_gradient_one	string	いいえ	—	グラデーションの 1 色目（HEX）。
foreground_gradient_two	string	いいえ	—	グラデーションの 2 色目（HEX）。
background_color	string	いいえ	#ffffff	背景の HEX 色。モジュールより明るくしてください。
background_color_transparency	integer	いいえ	0	背景の透明度、0–100。
custom_eyes_color	boolean	いいえ	false	true の場合、アイは eyes_inner_color と eyes_outer_color を使います。
eyes_inner_color	string	いいえ	#000000	内側アイの HEX 色。
eyes_outer_color	string	いいえ	#000000	外側アイの HEX 色。
qr_code_logo	string	いいえ	—	ロゴ画像の URL またはアップロード済みファイルキー。
qr_code_logo_size	number	いいえ	25	QR に対するロゴサイズ（パーセント）、5–40。
frame	string	いいえ	—	スタジオの任意フレームキー。
frame_text	string	いいえ	—	フレームに描くキャプション。

リクエスト例

curl -X PATCH 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://forqrcode.com/pricing",
  "foreground_color": "#5d2a1a"
}'

DELETE/api/v1/qr-codes/{id}

QR コードを削除

名前	型	必須	説明
id	integer	はい	—

curl -X DELETE 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

パラメータ名と JSON 例は英語です。YOUR_API_KEY を自分のキーに置き換えてください。