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 옵션 가능 정수 한 페이지당 표시할 결과 수를 입력하세요. 허용되는 값은 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}' \