QR codes

GET https://www.myshorturl.link/api/qr-codes/
curl --request GET \
--url 'https://www.myshorturl.link/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
パラメーター Details Description
page オプション 整数 結果を取得したいページ番号です。デフォルトは1です。
results_per_page オプション 整数 1ページあたりの結果の数を指定します。許可される値は10 , 25 , 50 , 100 , 250 , 500 , 1000です。デフォルトは25
{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://www.myshorturl.link/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://www.myshorturl.link/api/qr-codes?&page=1", "last": "https://www.myshorturl.link/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://www.myshorturl.link/api/qr-codes?&page=1" } }
GET https://www.myshorturl.link/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://www.myshorturl.link/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://www.myshorturl.link/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://www.myshorturl.link/api/qr-codes
パラメーター Details Description
project_id オプション 整数 -
name 必要 -
type 必要 許可される値: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi
is_bulk オプション ブール値 Available when: 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 オプション Available when: foreground_type = color
foreground_gradient_style オプション 許可される値: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one オプション Available when: foreground_type = gradient
foreground_gradient_two オプション Available when: foreground_type = gradient
background_color オプション
background_color_transparency オプション 整数
custom_eyes_color オプション ブール値
eyes_inner_color オプション Available when: custom_eyes_color = 1
eyes_outer_color オプション Available when: 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 オプション Available when: frame_custom_colors = 1
frame_text_color オプション Available when: frame_custom_colors = 1
size オプション 整数 50-2000
margin オプション 整数 0-25
ecc オプション 許可される値: L, M, Q, H
text オプション Available when: type = text
url オプション Available when: type = url
phone オプション Available when: type = phone
sms オプション Available when: type = sms
sms_body オプション Available when: type = sms
email オプション Available when: type = email
whatsapp オプション Available when: type = whatsapp
whatsapp_body オプション Available when: type = whatsapp
facetime オプション Available when: type = facetime
location
location_latitude オプション 浮く Available when: type = location
location_longitude オプション 浮く Available when: type = location
wifi
wifi_ssid オプション Available when: type = wifi
wifi_encryption オプション 許可される値: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password オプション Available when: type = wifi
wifi_is_hidden オプション ブール値 Available when: type = wifi
event オプション Available when: type = event
event_location オプション Available when: type = event
event_url オプション Available when: type = event
event_note オプション Available when: type = event
event_timezone オプション Available when: type = event
event_start_datetime オプション Available when: type = event
event_end_datetime オプション Available when: type = event
event_first_alert_datetime オプション Available when: type = event
event_second_alert_datetime オプション Available when: type = event
crypto
crypto_coin オプション Available when: type = crypto
crypto_address オプション Available when: type = crypto
crypto_amount オプション Available when: type = crypto
vcard
vcard_first_name オプション Available when: type = vcard
vcard_last_name オプション Available when: type = vcard
vcard_company オプション Available when: type = vcard
vcard_phone_number_label[index] オプション Available when: type = vcard
vcard_phone_number_value[index] オプション Available when: type = vcard
vcard_email オプション Available when: type = vcard
vcard_url オプション Available when: type = vcard
vcard_job_title オプション Available when: type = vcard
vcard_birthday オプション Available when: type = vcard
vcard_street オプション Available when: type = vcard
vcard_city オプション Available when: type = vcard
vcard_zip オプション Available when: type = vcard
vcard_region オプション Available when: type = vcard
vcard_country オプション Available when: type = vcard
vcard_note オプション Available when: type = vcard
vcard_social_label[index] オプション Available when: type = vcard
vcard_social_value[index] オプション Available when: type = vcard
paypal
paypal_type オプション 許可される値: buy_now, add_to_cart, donation (type=paypal)
paypal_email オプション Available when: type = paypal
paypal_title オプション Available when: type = paypal
paypal_currency オプション Available when: type = paypal
paypal_price オプション 浮く Available when: type = paypal
paypal_thank_you_url オプション Available when: type = paypal
paypal_cancel_url オプション Available when: type = paypal
upi
upi_payee_id オプション Available when: type = upi
upi_payee_name オプション Available when: type = upi
upi_currency オプション Available when: type = upi
upi_amount オプション 浮く Available when: type = upi
upi_transaction_id オプション Available when: type = upi
upi_transaction_note オプション Available when: type = upi
upi_transaction_reference オプション Available when: type = upi
upi_thank_you_url オプション Available when: type = upi
epc
epc_iban オプション Available when: type = epc
epc_payee_name オプション Available when: type = epc
epc_currency オプション Available when: type = epc
epc_amount オプション 浮く Available when: type = epc
epc_bic オプション Available when: type = epc
epc_remittance_reference オプション Available when: type = epc
epc_remittance_text オプション Available when: type = epc
information オプション Available when: type = epc
pix
pix_payee_key オプション Available when: type = pix
pix_payee_name オプション Available when: type = pix
pix_currency オプション Available when: type = pix
pix_amount オプション 浮く Available when: type = pix
pix_city オプション Available when: type = pix
pix_transaction_id オプション Available when: type = pix
pix_description オプション Available when: type = pix
パラメーター Details Description
curl --request POST \
--url 'https://www.myshorturl.link/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://www.myshorturl.link/api/qr-codes/{qr_code_id}
パラメーター Details Description
project_id オプション -
name オプション -
type オプション 許可される値: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi
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 オプション Available when: foreground_type = color
foreground_gradient_style オプション 許可される値: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one オプション Available when: foreground_type = gradient
foreground_gradient_two オプション Available when: foreground_type = gradient
background_color オプション
background_color_transparency オプション 整数 0 - 100
custom_eyes_color オプション ブール値
eyes_inner_color オプション Available when: custom_eyes_color = 1
eyes_outer_color オプション Available when: 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 オプション Available when: frame_custom_colors = 1
frame_text_color オプション Available when: frame_custom_colors = 1
size オプション 整数 50-2000
margin オプション 整数 0-25
ecc オプション 許可される値: L, M, Q, H
text オプション Available when: type = text
url オプション Available when: type = url
phone オプション Available when: type = phone
sms オプション Available when: type = sms
sms_body オプション Available when: type = sms
email オプション Available when: type = email
whatsapp オプション Available when: type = whatsapp
whatsapp_body オプション Available when: type = whatsapp
facetime オプション Available when: type = facetime
location
location_latitude オプション 浮く Available when: type = location
location_longitude オプション 浮く Available when: type = location
wifi
wifi_ssid オプション Available when: type = wifi
wifi_encryption オプション 許可される値: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password オプション Available when: type = wifi
wifi_is_hidden オプション ブール値 Available when: type = wifi
event オプション Available when: type = event
event_location オプション Available when: type = event
event_url オプション Available when: type = event
event_note オプション Available when: type = event
event_timezone オプション Available when: type = event
event_start_datetime オプション Available when: type = event
event_end_datetime オプション Available when: type = event
event_first_alert_datetime オプション Available when: type = event
event_second_alert_datetime オプション Available when: type = event
crypto
crypto_coin オプション Available when: type = crypto
crypto_address オプション Available when: type = crypto
crypto_amount オプション Available when: type = crypto
vcard
vcard_first_name オプション Available when: type = vcard
vcard_last_name オプション Available when: type = vcard
vcard_company オプション Available when: type = vcard
vcard_phone_number_label[index] オプション Available when: type = vcard
vcard_phone_number_value[index] オプション Available when: type = vcard
vcard_email オプション Available when: type = vcard
vcard_url オプション Available when: type = vcard
vcard_job_title オプション Available when: type = vcard
vcard_birthday オプション Available when: type = vcard
vcard_street オプション Available when: type = vcard
vcard_city オプション Available when: type = vcard
vcard_zip オプション Available when: type = vcard
vcard_region オプション Available when: type = vcard
vcard_country オプション Available when: type = vcard
vcard_note オプション Available when: type = vcard
vcard_social_label[index] オプション Available when: type = vcard
vcard_social_value[index] オプション Available when: type = vcard
paypal
paypal_type オプション 許可される値: buy_now, add_to_cart, donation (type=paypal)
paypal_email オプション Available when: type = paypal
paypal_title オプション Available when: type = paypal
paypal_currency オプション Available when: type = paypal
paypal_price オプション 浮く Available when: type = paypal
paypal_thank_you_url オプション Available when: type = paypal
paypal_cancel_url オプション Available when: type = paypal
upi
upi_payee_id オプション Available when: type = upi
upi_payee_name オプション Available when: type = upi
upi_currency オプション Available when: type = upi
upi_amount オプション 浮く Available when: type = upi
upi_transaction_id オプション Available when: type = upi
upi_transaction_note オプション Available when: type = upi
upi_transaction_reference オプション Available when: type = upi
upi_thank_you_url オプション Available when: type = upi
epc
epc_iban オプション Available when: type = epc
epc_payee_name オプション Available when: type = epc
epc_currency オプション Available when: type = epc
epc_amount オプション 浮く Available when: type = epc
epc_bic オプション Available when: type = epc
epc_remittance_reference オプション Available when: type = epc
epc_remittance_text オプション Available when: type = epc
information オプション Available when: type = epc
pix
pix_payee_key オプション Available when: type = pix
pix_payee_name オプション Available when: type = pix
pix_currency オプション Available when: type = pix
pix_amount オプション 浮く Available when: type = pix
pix_city オプション Available when: type = pix
pix_transaction_id オプション Available when: type = pix
pix_description オプション Available when: type = pix
curl --request POST \
--url 'https://www.myshorturl.link/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://www.myshorturl.link/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://www.myshorturl.link/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \