QRコード

GET https://wlinky.com/api/qr-codes/
curl --request GET \
--url 'https://wlinky.com/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
パラメータ 詳細 説明
page 任意 整数 結果を取得したいページ番号。デフォルトは1
results_per_page 任意 整数 ページあたりの結果数。許可される値は10 , 25 , 50 , 100 , 250 , 500 , 1000。デフォルトは25
{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://wlinky.com/uploads/qr_code/example.svg", "qr_code_logo": null, "qr_code_background": null, "settings": { "foreground_type": "color", "foreground_color": "#000000", "background_color": "#ffffff", "custom_eyes_color": false, "qr_code_logo_size": 25, "size": 500, "margin": 0, "ecc": "L", "url": "https://example.com" ... }, "embedded_data": "https://example.com", "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" }, ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://wlinky.com/api/qr-codes?&page=1", "last": "https://wlinky.com/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://wlinky.com/api/qr-codes?&page=1" } }
GET https://wlinky.com/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://wlinky.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://wlinky.com/uploads/qr_code/example.svg", "qr_code_logo": null, "qr_code_background": null, "settings": { "foreground_type": "color", "foreground_color": "#000000", "background_color": "#ffffff", "custom_eyes_color": false, "qr_code_logo_size": 25, "size": 500, "margin": 0, "ecc": "L", "url": "https://example.com" ... }, "embedded_data": "https://example.com", "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" } }
POST https://wlinky.com/api/qr-codes
パラメータ 詳細 説明
project_id 任意 整数 -
name 必須 文字列 -
type 必須 文字列 許可される値: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
is_bulk 任意 真偽値 利用可能条件: type = text
style 任意 文字列 許可される値: square, dot, round, diamond, heart
inner_eye_style 任意 文字列 許可される値: square, dot, rounded, diamond, flower, leaf
outer_eye_style 任意 文字列 許可される値: square, circle, rounded, flower, leaf
foreground_type 任意 文字列 許可される値: color, gradient
foreground_color 任意 文字列 利用可能条件: foreground_type = color
foreground_gradient_style 任意 文字列 許可される値: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one 任意 文字列 利用可能条件: foreground_type = gradient
foreground_gradient_two 任意 文字列 利用可能条件: foreground_type = gradient
background_color 任意 文字列
background_color_transparency 任意 整数
custom_eyes_color 任意 真偽値
eyes_inner_color 任意 文字列 利用可能条件: custom_eyes_color = 1
eyes_outer_color 任意 文字列 利用可能条件: custom_eyes_color = 1
qr_code_logo 任意 ファイル -
qr_code_logo_size 任意 整数 5-35
qr_code_background 任意 ファイル -
qr_code_background_transparency 任意 整数 0-100
qr_code_foreground 任意 ファイル -
qr_code_foreground_transparency 任意 整数 0-100
frame 任意 文字列 許可される値: round_bottom_text, round_top_text, tooltip_bottom_text, tooltip_top_text, ribbon_bottom_text, ribbon_top_text, tooltip_snap_top_text, tooltip_snap_bottom_text
frame_text 任意 文字列
frame_text_size 任意 整数 -5 - 5
frame_text_font 任意 文字列 許可される値: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, monaco, comic_sans_ms, impact, luminari, baskerville, papyrus, brush_script_mt
frame_custom_colors 任意 真偽値
frame_color 任意 文字列 利用可能条件: frame_custom_colors = 1
frame_text_color 任意 文字列 利用可能条件: frame_custom_colors = 1
size 任意 整数 50-2000
margin 任意 整数 0-25
ecc 任意 文字列 許可される値: L, M, Q, H
text 任意 文字列 利用可能条件: type = text
url 任意 文字列 利用可能条件: type = url
phone 任意 文字列 利用可能条件: type = phone
sms 任意 文字列 利用可能条件: type = sms
sms_body 任意 文字列 利用可能条件: type = sms
email 任意 文字列 利用可能条件: type = email
whatsapp 任意 文字列 利用可能条件: type = whatsapp
whatsapp_body 任意 文字列 利用可能条件: type = whatsapp
facetime 任意 文字列 利用可能条件: type = facetime
location
location_latitude 任意 小数点数 利用可能条件: type = location
location_longitude 任意 小数点数 利用可能条件: type = location
wifi
wifi_ssid 任意 文字列 利用可能条件: type = wifi
wifi_encryption 任意 文字列 許可される値: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password 任意 文字列 利用可能条件: type = wifi
wifi_is_hidden 任意 真偽値 利用可能条件: type = wifi
event 任意 文字列 利用可能条件: type = event
event_location 任意 文字列 利用可能条件: type = event
event_url 任意 文字列 利用可能条件: type = event
event_note 任意 文字列 利用可能条件: type = event
event_timezone 任意 文字列 利用可能条件: type = event
event_start_datetime 任意 文字列 利用可能条件: type = event
event_end_datetime 任意 文字列 利用可能条件: type = event
event_first_alert_datetime 任意 文字列 利用可能条件: type = event
event_second_alert_datetime 任意 文字列 利用可能条件: type = event
crypto
crypto_coin 任意 文字列 利用可能条件: type = crypto
crypto_address 任意 文字列 利用可能条件: type = crypto
crypto_amount 任意 文字列 利用可能条件: type = crypto
vcard
vcard_first_name 任意 文字列 利用可能条件: type = vcard
vcard_last_name 任意 文字列 利用可能条件: type = vcard
vcard_company 任意 文字列 利用可能条件: type = vcard
vcard_phone_number_label[index] 任意 文字列 利用可能条件: type = vcard
vcard_phone_number_value[index] 任意 文字列 利用可能条件: type = vcard
vcard_email 任意 文字列 利用可能条件: type = vcard
vcard_url 任意 文字列 利用可能条件: type = vcard
vcard_job_title 任意 文字列 利用可能条件: type = vcard
vcard_birthday 任意 文字列 利用可能条件: type = vcard
vcard_street 任意 文字列 利用可能条件: type = vcard
vcard_city 任意 文字列 利用可能条件: type = vcard
vcard_zip 任意 文字列 利用可能条件: type = vcard
vcard_region 任意 文字列 利用可能条件: type = vcard
vcard_country 任意 文字列 利用可能条件: type = vcard
vcard_note 任意 文字列 利用可能条件: type = vcard
vcard_social_label[index] 任意 文字列 利用可能条件: type = vcard
vcard_social_value[index] 任意 文字列 利用可能条件: type = vcard
paypal
paypal_type 任意 文字列 許可される値: buy_now, add_to_cart, donation (type=paypal)
paypal_email 任意 文字列 利用可能条件: type = paypal
paypal_title 任意 文字列 利用可能条件: type = paypal
paypal_currency 任意 文字列 利用可能条件: type = paypal
paypal_price 任意 小数点数 利用可能条件: type = paypal
paypal_thank_you_url 任意 文字列 利用可能条件: type = paypal
paypal_cancel_url 任意 文字列 利用可能条件: type = paypal
upi
upi_payee_id 任意 文字列 利用可能条件: type = upi
upi_payee_name 任意 文字列 利用可能条件: type = upi
upi_currency 任意 文字列 利用可能条件: type = upi
upi_amount 任意 小数点数 利用可能条件: type = upi
upi_transaction_id 任意 文字列 利用可能条件: type = upi
upi_transaction_note 任意 文字列 利用可能条件: type = upi
upi_transaction_reference 任意 文字列 利用可能条件: type = upi
upi_thank_you_url 任意 文字列 利用可能条件: type = upi
epc
epc_iban 任意 文字列 利用可能条件: type = epc
epc_payee_name 任意 文字列 利用可能条件: type = epc
epc_currency 任意 文字列 利用可能条件: type = epc
epc_amount 任意 小数点数 利用可能条件: type = epc
epc_bic 任意 文字列 利用可能条件: type = epc
epc_remittance_reference 任意 文字列 利用可能条件: type = epc
epc_remittance_text 任意 文字列 利用可能条件: type = epc
information 任意 文字列 利用可能条件: type = epc
pix
pix_payee_key 任意 文字列 利用可能条件: type = pix
pix_payee_name 任意 文字列 利用可能条件: type = pix
pix_currency 任意 文字列 利用可能条件: type = pix
pix_amount 任意 小数点数 利用可能条件: type = pix
pix_city 任意 文字列 利用可能条件: type = pix
pix_transaction_id 任意 文字列 利用可能条件: type = pix
pix_description 任意 文字列 利用可能条件: type = pix
パラメータ 詳細 説明
curl --request POST \
--url 'https://wlinky.com/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \
{ "data": { "id": 1 } }
POST https://wlinky.com/api/qr-codes/{qr_code_id}
パラメータ 詳細 説明
project_id 任意 文字列 -
name 任意 文字列 -
type 任意 文字列 許可される値: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
style 任意 文字列 許可される値: square, dot, round, diamond, heart
inner_eye_style 任意 文字列 許可される値: square, dot, rounded, diamond, flower, leaf
outer_eye_style 任意 文字列 許可される値: square, circle, rounded, flower, leaf
foreground_type 任意 文字列 許可される値: color, gradient
foreground_color 任意 文字列 利用可能条件: foreground_type = color
foreground_gradient_style 任意 文字列 許可される値: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one 任意 文字列 利用可能条件: foreground_type = gradient
foreground_gradient_two 任意 文字列 利用可能条件: foreground_type = gradient
background_color 任意 文字列
background_color_transparency 任意 整数 0 - 100
custom_eyes_color 任意 真偽値
eyes_inner_color 任意 文字列 利用可能条件: custom_eyes_color = 1
eyes_outer_color 任意 文字列 利用可能条件: custom_eyes_color = 1
qr_code_logo 任意 ファイル -
qr_code_logo_size 任意 整数 5-35
qr_code_background 任意 ファイル -
qr_code_background_transparency 任意 整数 0-100
qr_code_foreground 任意 ファイル -
qr_code_foreground_transparency 任意 整数 0-100
frame 任意 文字列 許可される値: round_bottom_text, round_top_text, tooltip_bottom_text, tooltip_top_text, ribbon_bottom_text, ribbon_top_text, tooltip_snap_top_text, tooltip_snap_bottom_text
frame_text 任意 文字列
frame_text_size 任意 整数 -5 -> 5
frame_text_font 任意 文字列 許可される値: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, monaco, comic_sans_ms, impact, luminari, baskerville, papyrus, brush_script_mt
frame_custom_colors 任意 真偽値
frame_color 任意 文字列 利用可能条件: frame_custom_colors = 1
frame_text_color 任意 文字列 利用可能条件: frame_custom_colors = 1
size 任意 整数 50-2000
margin 任意 整数 0-25
ecc 任意 文字列 許可される値: L, M, Q, H
text 任意 文字列 利用可能条件: type = text
url 任意 文字列 利用可能条件: type = url
phone 任意 文字列 利用可能条件: type = phone
sms 任意 文字列 利用可能条件: type = sms
sms_body 任意 文字列 利用可能条件: type = sms
email 任意 文字列 利用可能条件: type = email
whatsapp 任意 文字列 利用可能条件: type = whatsapp
whatsapp_body 任意 文字列 利用可能条件: type = whatsapp
facetime 任意 文字列 利用可能条件: type = facetime
location
location_latitude 任意 小数点数 利用可能条件: type = location
location_longitude 任意 小数点数 利用可能条件: type = location
wifi
wifi_ssid 任意 文字列 利用可能条件: type = wifi
wifi_encryption 任意 文字列 許可される値: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password 任意 文字列 利用可能条件: type = wifi
wifi_is_hidden 任意 真偽値 利用可能条件: type = wifi
event 任意 文字列 利用可能条件: type = event
event_location 任意 文字列 利用可能条件: type = event
event_url 任意 文字列 利用可能条件: type = event
event_note 任意 文字列 利用可能条件: type = event
event_timezone 任意 文字列 利用可能条件: type = event
event_start_datetime 任意 文字列 利用可能条件: type = event
event_end_datetime 任意 文字列 利用可能条件: type = event
event_first_alert_datetime 任意 文字列 利用可能条件: type = event
event_second_alert_datetime 任意 文字列 利用可能条件: type = event
crypto
crypto_coin 任意 文字列 利用可能条件: type = crypto
crypto_address 任意 文字列 利用可能条件: type = crypto
crypto_amount 任意 文字列 利用可能条件: type = crypto
vcard
vcard_first_name 任意 文字列 利用可能条件: type = vcard
vcard_last_name 任意 文字列 利用可能条件: type = vcard
vcard_company 任意 文字列 利用可能条件: type = vcard
vcard_phone_number_label[index] 任意 文字列 利用可能条件: type = vcard
vcard_phone_number_value[index] 任意 文字列 利用可能条件: type = vcard
vcard_email 任意 文字列 利用可能条件: type = vcard
vcard_url 任意 文字列 利用可能条件: type = vcard
vcard_job_title 任意 文字列 利用可能条件: type = vcard
vcard_birthday 任意 文字列 利用可能条件: type = vcard
vcard_street 任意 文字列 利用可能条件: type = vcard
vcard_city 任意 文字列 利用可能条件: type = vcard
vcard_zip 任意 文字列 利用可能条件: type = vcard
vcard_region 任意 文字列 利用可能条件: type = vcard
vcard_country 任意 文字列 利用可能条件: type = vcard
vcard_note 任意 文字列 利用可能条件: type = vcard
vcard_social_label[index] 任意 文字列 利用可能条件: type = vcard
vcard_social_value[index] 任意 文字列 利用可能条件: type = vcard
paypal
paypal_type 任意 文字列 許可される値: buy_now, add_to_cart, donation (type=paypal)
paypal_email 任意 文字列 利用可能条件: type = paypal
paypal_title 任意 文字列 利用可能条件: type = paypal
paypal_currency 任意 文字列 利用可能条件: type = paypal
paypal_price 任意 小数点数 利用可能条件: type = paypal
paypal_thank_you_url 任意 文字列 利用可能条件: type = paypal
paypal_cancel_url 任意 文字列 利用可能条件: type = paypal
upi
upi_payee_id 任意 文字列 利用可能条件: type = upi
upi_payee_name 任意 文字列 利用可能条件: type = upi
upi_currency 任意 文字列 利用可能条件: type = upi
upi_amount 任意 小数点数 利用可能条件: type = upi
upi_transaction_id 任意 文字列 利用可能条件: type = upi
upi_transaction_note 任意 文字列 利用可能条件: type = upi
upi_transaction_reference 任意 文字列 利用可能条件: type = upi
upi_thank_you_url 任意 文字列 利用可能条件: type = upi
epc
epc_iban 任意 文字列 利用可能条件: type = epc
epc_payee_name 任意 文字列 利用可能条件: type = epc
epc_currency 任意 文字列 利用可能条件: type = epc
epc_amount 任意 小数点数 利用可能条件: type = epc
epc_bic 任意 文字列 利用可能条件: type = epc
epc_remittance_reference 任意 文字列 利用可能条件: type = epc
epc_remittance_text 任意 文字列 利用可能条件: type = epc
information 任意 文字列 利用可能条件: type = epc
pix
pix_payee_key 任意 文字列 利用可能条件: type = pix
pix_payee_name 任意 文字列 利用可能条件: type = pix
pix_currency 任意 文字列 利用可能条件: type = pix
pix_amount 任意 小数点数 利用可能条件: type = pix
pix_city 任意 文字列 利用可能条件: type = pix
pix_transaction_id 任意 文字列 利用可能条件: type = pix
pix_description 任意 文字列 利用可能条件: type = pix
curl --request POST \
--url 'https://wlinky.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \
{ "data": { "id": 1 } }
DELETE https://wlinky.com/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://wlinky.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \