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}' \
Tham số. Details Description
page Tùy chọn. Số nguyên Số trang mà bạn muốn kết quả từ đó. Mặc định là 1.
results_per_page Tùy chọn. Số nguyên Bạn muốn bao nhiêu kết quả trên mỗi trang. Giá trị cho phép là: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Mặc định là 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
Tham số. Details Description
project_id Tùy chọn. Số nguyên -
name Yêu cầu Chuỗi -
type Yêu cầu Chuỗi Giá trị được cho phép: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi.
is_bulk Tùy chọn. Boolean. Available when: type = text
style Tùy chọn. Chuỗi Giá trị được cho phép: square, dot, round, diamond, heart.
inner_eye_style Tùy chọn. Chuỗi Giá trị được cho phép: square, dot, rounded, diamond, flower, leaf.
outer_eye_style Tùy chọn. Chuỗi Giá trị được cho phép: square, circle, rounded, flower, leaf.
foreground_type Tùy chọn. Chuỗi Giá trị được cho phép: color, gradient.
foreground_color Tùy chọn. Chuỗi Available when: foreground_type = color
foreground_gradient_style Tùy chọn. Chuỗi Giá trị được cho phép: vertical, horizontal, diagonal, inverse_diagonal, radial.
foreground_gradient_one Tùy chọn. Chuỗi Available when: foreground_type = gradient
foreground_gradient_two Tùy chọn. Chuỗi Available when: foreground_type = gradient
background_color Tùy chọn. Chuỗi
background_color_transparency Tùy chọn. Số nguyên
custom_eyes_color Tùy chọn. Boolean.
eyes_inner_color Tùy chọn. Chuỗi Available when: custom_eyes_color = 1
eyes_outer_color Tùy chọn. Chuỗi Available when: custom_eyes_color = 1
qr_code_logo Tùy chọn. Tệp -
qr_code_logo_size Tùy chọn. Số nguyên 5-35
qr_code_background Tùy chọn. Tệp -
qr_code_background_transparency Tùy chọn. Số nguyên 0-100
qr_code_foreground Tùy chọn. Tệp -
qr_code_foreground_transparency Tùy chọn. Số nguyên 0-100
frame Tùy chọn. Chuỗi Giá trị được cho phép: 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 Tùy chọn. Chuỗi
frame_text_size Tùy chọn. Số nguyên -5 - 5
frame_text_font Tùy chọn. Chuỗi Giá trị được cho phép: 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 Tùy chọn. Boolean.
frame_color Tùy chọn. Chuỗi Available when: frame_custom_colors = 1
frame_text_color Tùy chọn. Chuỗi Available when: frame_custom_colors = 1
size Tùy chọn. Số nguyên 50-2000
margin Tùy chọn. Số nguyên 0-25
ecc Tùy chọn. Chuỗi Giá trị được cho phép: L, M, Q, H.
text Tùy chọn. Chuỗi Available when: type = text
url Tùy chọn. Chuỗi Available when: type = url
phone Tùy chọn. Chuỗi Available when: type = phone
sms Tùy chọn. Chuỗi Available when: type = sms
sms_body Tùy chọn. Chuỗi Available when: type = sms
email Tùy chọn. Chuỗi Available when: type = email
whatsapp Tùy chọn. Chuỗi Available when: type = whatsapp
whatsapp_body Tùy chọn. Chuỗi Available when: type = whatsapp
facetime Tùy chọn. Chuỗi Available when: type = facetime
location
location_latitude Tùy chọn. Float. Available when: type = location
location_longitude Tùy chọn. Float. Available when: type = location
wifi
wifi_ssid Tùy chọn. Chuỗi Available when: type = wifi
wifi_encryption Tùy chọn. Chuỗi Giá trị được cho phép: nopass, WEP, WPA/WPA2, H. (type=wifi)
wifi_password Tùy chọn. Chuỗi Available when: type = wifi
wifi_is_hidden Tùy chọn. Boolean. Available when: type = wifi
event Tùy chọn. Chuỗi Available when: type = event
event_location Tùy chọn. Chuỗi Available when: type = event
event_url Tùy chọn. Chuỗi Available when: type = event
event_note Tùy chọn. Chuỗi Available when: type = event
event_timezone Tùy chọn. Chuỗi Available when: type = event
event_start_datetime Tùy chọn. Chuỗi Available when: type = event
event_end_datetime Tùy chọn. Chuỗi Available when: type = event
event_first_alert_datetime Tùy chọn. Chuỗi Available when: type = event
event_second_alert_datetime Tùy chọn. Chuỗi Available when: type = event
crypto
crypto_coin Tùy chọn. Chuỗi Available when: type = crypto
crypto_address Tùy chọn. Chuỗi Available when: type = crypto
crypto_amount Tùy chọn. Chuỗi Available when: type = crypto
vcard
vcard_first_name Tùy chọn. Chuỗi Available when: type = vcard
vcard_last_name Tùy chọn. Chuỗi Available when: type = vcard
vcard_company Tùy chọn. Chuỗi Available when: type = vcard
vcard_phone_number_label[index] Tùy chọn. Chuỗi Available when: type = vcard
vcard_phone_number_value[index] Tùy chọn. Chuỗi Available when: type = vcard
vcard_email Tùy chọn. Chuỗi Available when: type = vcard
vcard_url Tùy chọn. Chuỗi Available when: type = vcard
vcard_job_title Tùy chọn. Chuỗi Available when: type = vcard
vcard_birthday Tùy chọn. Chuỗi Available when: type = vcard
vcard_street Tùy chọn. Chuỗi Available when: type = vcard
vcard_city Tùy chọn. Chuỗi Available when: type = vcard
vcard_zip Tùy chọn. Chuỗi Available when: type = vcard
vcard_region Tùy chọn. Chuỗi Available when: type = vcard
vcard_country Tùy chọn. Chuỗi Available when: type = vcard
vcard_note Tùy chọn. Chuỗi Available when: type = vcard
vcard_social_label[index] Tùy chọn. Chuỗi Available when: type = vcard
vcard_social_value[index] Tùy chọn. Chuỗi Available when: type = vcard
paypal
paypal_type Tùy chọn. Chuỗi Giá trị được cho phép: buy_now, add_to_cart, donation. (type=paypal)
paypal_email Tùy chọn. Chuỗi Available when: type = paypal
paypal_title Tùy chọn. Chuỗi Available when: type = paypal
paypal_currency Tùy chọn. Chuỗi Available when: type = paypal
paypal_price Tùy chọn. Float. Available when: type = paypal
paypal_thank_you_url Tùy chọn. Chuỗi Available when: type = paypal
paypal_cancel_url Tùy chọn. Chuỗi Available when: type = paypal
upi
upi_payee_id Tùy chọn. Chuỗi Available when: type = upi
upi_payee_name Tùy chọn. Chuỗi Available when: type = upi
upi_currency Tùy chọn. Chuỗi Available when: type = upi
upi_amount Tùy chọn. Float. Available when: type = upi
upi_transaction_id Tùy chọn. Chuỗi Available when: type = upi
upi_transaction_note Tùy chọn. Chuỗi Available when: type = upi
upi_transaction_reference Tùy chọn. Chuỗi Available when: type = upi
upi_thank_you_url Tùy chọn. Chuỗi Available when: type = upi
epc
epc_iban Tùy chọn. Chuỗi Available when: type = epc
epc_payee_name Tùy chọn. Chuỗi Available when: type = epc
epc_currency Tùy chọn. Chuỗi Available when: type = epc
epc_amount Tùy chọn. Float. Available when: type = epc
epc_bic Tùy chọn. Chuỗi Available when: type = epc
epc_remittance_reference Tùy chọn. Chuỗi Available when: type = epc
epc_remittance_text Tùy chọn. Chuỗi Available when: type = epc
information Tùy chọn. Chuỗi Available when: type = epc
pix
pix_payee_key Tùy chọn. Chuỗi Available when: type = pix
pix_payee_name Tùy chọn. Chuỗi Available when: type = pix
pix_currency Tùy chọn. Chuỗi Available when: type = pix
pix_amount Tùy chọn. Float. Available when: type = pix
pix_city Tùy chọn. Chuỗi Available when: type = pix
pix_transaction_id Tùy chọn. Chuỗi Available when: type = pix
pix_description Tùy chọn. Chuỗi Available when: type = pix
Tham số. 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}
Tham số. Details Description
project_id Tùy chọn. Chuỗi -
name Tùy chọn. Chuỗi -
type Tùy chọn. Chuỗi Giá trị được cho phép: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi.
style Tùy chọn. Chuỗi Giá trị được cho phép: square, dot, round, diamond, heart.
inner_eye_style Tùy chọn. Chuỗi Giá trị được cho phép: square, dot, rounded, diamond, flower, leaf.
outer_eye_style Tùy chọn. Chuỗi Giá trị được cho phép: square, circle, rounded, flower, leaf.
foreground_type Tùy chọn. Chuỗi Giá trị được cho phép: color, gradient.
foreground_color Tùy chọn. Chuỗi Available when: foreground_type = color
foreground_gradient_style Tùy chọn. Chuỗi Giá trị được cho phép: vertical, horizontal, diagonal, inverse_diagonal, radial.
foreground_gradient_one Tùy chọn. Chuỗi Available when: foreground_type = gradient
foreground_gradient_two Tùy chọn. Chuỗi Available when: foreground_type = gradient
background_color Tùy chọn. Chuỗi
background_color_transparency Tùy chọn. Số nguyên 0 - 100
custom_eyes_color Tùy chọn. Boolean.
eyes_inner_color Tùy chọn. Chuỗi Available when: custom_eyes_color = 1
eyes_outer_color Tùy chọn. Chuỗi Available when: custom_eyes_color = 1
qr_code_logo Tùy chọn. Tệp -
qr_code_logo_size Tùy chọn. Số nguyên 5-35
qr_code_background Tùy chọn. Tệp -
qr_code_background_transparency Tùy chọn. Số nguyên 0-100
qr_code_foreground Tùy chọn. Tệp -
qr_code_foreground_transparency Tùy chọn. Số nguyên 0-100
frame Tùy chọn. Chuỗi Giá trị được cho phép: 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 Tùy chọn. Chuỗi
frame_text_size Tùy chọn. Số nguyên -5 -> 5
frame_text_font Tùy chọn. Chuỗi Giá trị được cho phép: 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 Tùy chọn. Boolean.
frame_color Tùy chọn. Chuỗi Available when: frame_custom_colors = 1
frame_text_color Tùy chọn. Chuỗi Available when: frame_custom_colors = 1
size Tùy chọn. Số nguyên 50-2000
margin Tùy chọn. Số nguyên 0-25
ecc Tùy chọn. Chuỗi Giá trị được cho phép: L, M, Q, H.
text Tùy chọn. Chuỗi Available when: type = text
url Tùy chọn. Chuỗi Available when: type = url
phone Tùy chọn. Chuỗi Available when: type = phone
sms Tùy chọn. Chuỗi Available when: type = sms
sms_body Tùy chọn. Chuỗi Available when: type = sms
email Tùy chọn. Chuỗi Available when: type = email
whatsapp Tùy chọn. Chuỗi Available when: type = whatsapp
whatsapp_body Tùy chọn. Chuỗi Available when: type = whatsapp
facetime Tùy chọn. Chuỗi Available when: type = facetime
location
location_latitude Tùy chọn. Float. Available when: type = location
location_longitude Tùy chọn. Float. Available when: type = location
wifi
wifi_ssid Tùy chọn. Chuỗi Available when: type = wifi
wifi_encryption Tùy chọn. Chuỗi Giá trị được cho phép: nopass, WEP, WPA/WPA2, H. (type=wifi)
wifi_password Tùy chọn. Chuỗi Available when: type = wifi
wifi_is_hidden Tùy chọn. Boolean. Available when: type = wifi
event Tùy chọn. Chuỗi Available when: type = event
event_location Tùy chọn. Chuỗi Available when: type = event
event_url Tùy chọn. Chuỗi Available when: type = event
event_note Tùy chọn. Chuỗi Available when: type = event
event_timezone Tùy chọn. Chuỗi Available when: type = event
event_start_datetime Tùy chọn. Chuỗi Available when: type = event
event_end_datetime Tùy chọn. Chuỗi Available when: type = event
event_first_alert_datetime Tùy chọn. Chuỗi Available when: type = event
event_second_alert_datetime Tùy chọn. Chuỗi Available when: type = event
crypto
crypto_coin Tùy chọn. Chuỗi Available when: type = crypto
crypto_address Tùy chọn. Chuỗi Available when: type = crypto
crypto_amount Tùy chọn. Chuỗi Available when: type = crypto
vcard
vcard_first_name Tùy chọn. Chuỗi Available when: type = vcard
vcard_last_name Tùy chọn. Chuỗi Available when: type = vcard
vcard_company Tùy chọn. Chuỗi Available when: type = vcard
vcard_phone_number_label[index] Tùy chọn. Chuỗi Available when: type = vcard
vcard_phone_number_value[index] Tùy chọn. Chuỗi Available when: type = vcard
vcard_email Tùy chọn. Chuỗi Available when: type = vcard
vcard_url Tùy chọn. Chuỗi Available when: type = vcard
vcard_job_title Tùy chọn. Chuỗi Available when: type = vcard
vcard_birthday Tùy chọn. Chuỗi Available when: type = vcard
vcard_street Tùy chọn. Chuỗi Available when: type = vcard
vcard_city Tùy chọn. Chuỗi Available when: type = vcard
vcard_zip Tùy chọn. Chuỗi Available when: type = vcard
vcard_region Tùy chọn. Chuỗi Available when: type = vcard
vcard_country Tùy chọn. Chuỗi Available when: type = vcard
vcard_note Tùy chọn. Chuỗi Available when: type = vcard
vcard_social_label[index] Tùy chọn. Chuỗi Available when: type = vcard
vcard_social_value[index] Tùy chọn. Chuỗi Available when: type = vcard
paypal
paypal_type Tùy chọn. Chuỗi Giá trị được cho phép: buy_now, add_to_cart, donation. (type=paypal)
paypal_email Tùy chọn. Chuỗi Available when: type = paypal
paypal_title Tùy chọn. Chuỗi Available when: type = paypal
paypal_currency Tùy chọn. Chuỗi Available when: type = paypal
paypal_price Tùy chọn. Float. Available when: type = paypal
paypal_thank_you_url Tùy chọn. Chuỗi Available when: type = paypal
paypal_cancel_url Tùy chọn. Chuỗi Available when: type = paypal
upi
upi_payee_id Tùy chọn. Chuỗi Available when: type = upi
upi_payee_name Tùy chọn. Chuỗi Available when: type = upi
upi_currency Tùy chọn. Chuỗi Available when: type = upi
upi_amount Tùy chọn. Float. Available when: type = upi
upi_transaction_id Tùy chọn. Chuỗi Available when: type = upi
upi_transaction_note Tùy chọn. Chuỗi Available when: type = upi
upi_transaction_reference Tùy chọn. Chuỗi Available when: type = upi
upi_thank_you_url Tùy chọn. Chuỗi Available when: type = upi
epc
epc_iban Tùy chọn. Chuỗi Available when: type = epc
epc_payee_name Tùy chọn. Chuỗi Available when: type = epc
epc_currency Tùy chọn. Chuỗi Available when: type = epc
epc_amount Tùy chọn. Float. Available when: type = epc
epc_bic Tùy chọn. Chuỗi Available when: type = epc
epc_remittance_reference Tùy chọn. Chuỗi Available when: type = epc
epc_remittance_text Tùy chọn. Chuỗi Available when: type = epc
information Tùy chọn. Chuỗi Available when: type = epc
pix
pix_payee_key Tùy chọn. Chuỗi Available when: type = pix
pix_payee_name Tùy chọn. Chuỗi Available when: type = pix
pix_currency Tùy chọn. Chuỗi Available when: type = pix
pix_amount Tùy chọn. Float. Available when: type = pix
pix_city Tùy chọn. Chuỗi Available when: type = pix
pix_transaction_id Tùy chọn. Chuỗi Available when: type = pix
pix_description Tùy chọn. Chuỗi 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}' \