→ Short Links & QR codes for Agencies

Codici QR

Recupera tutto

GET https://sqr.co/api/qr-codes/
curl --request GET \
--url 'https://sqr.co/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Parametri Dettagli Descrizione
page Facoltativo Intero Il numero di pagina da cui desideri i risultati. Predefinito a 1
results_per_page Facoltativo Intero Quanti risultati vuoi per pagina. I valori consentiti sono: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Il valore predefinito è 25.
{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://sqr.co/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://sqr.co/api/qr-codes?&page=1", "last": "https://sqr.co/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://sqr.co/api/qr-codes?&page=1" } }

Recupera uno

GET https://sqr.co/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://sqr.co/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://sqr.co/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" } }

Crea

POST https://sqr.co/api/qr-codes
Parametri Dettagli Descrizione
link_id Facoltativo Intero -
project_id Facoltativo Intero -
name Richiesto Stringa -
type Richiesto Stringa Valori consentiti: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
is_bulk Facoltativo Booleano Available when: type = text
style Facoltativo Stringa Valori consentiti: square, dot, round, diamond, heart
inner_eye_style Facoltativo Stringa Valori consentiti: square, dot, rounded, diamond, flower, leaf
outer_eye_style Facoltativo Stringa Valori consentiti: square, circle, rounded, flower, leaf
foreground_type Facoltativo Stringa Valori consentiti: color, gradient
foreground_color Facoltativo Stringa Available when: foreground_type = color
foreground_gradient_style Facoltativo Stringa Valori consentiti: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Facoltativo Stringa Available when: foreground_type = gradient
foreground_gradient_two Facoltativo Stringa Available when: foreground_type = gradient
background_color Facoltativo Stringa
background_color_transparency Facoltativo Intero
custom_eyes_color Facoltativo Booleano
eyes_inner_color Facoltativo Stringa Available when: custom_eyes_color = 1
eyes_outer_color Facoltativo Stringa Available when: custom_eyes_color = 1
qr_code_logo Facoltativo File -
qr_code_logo_size Facoltativo Intero 5-35
qr_code_background Facoltativo File -
qr_code_background_transparency Facoltativo Intero 0-100
qr_code_foreground Facoltativo File -
qr_code_foreground_transparency Facoltativo Intero 0-100
frame Facoltativo Stringa Valori consentiti: 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 Facoltativo Stringa
frame_text_size Facoltativo Intero -5 - 5
frame_text_font Facoltativo Stringa Valori consentiti: 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 Facoltativo Booleano
frame_color Facoltativo Stringa Available when: frame_custom_colors = 1
frame_text_color Facoltativo Stringa Available when: frame_custom_colors = 1
size Facoltativo Intero 50-2000
margin Facoltativo Intero 0-25
ecc Facoltativo Stringa Valori consentiti: L, M, Q, H
text Facoltativo Stringa Available when: type = text
url Facoltativo Stringa Available when: type = url
phone Facoltativo Stringa Available when: type = phone
sms Facoltativo Stringa Available when: type = sms
sms_body Facoltativo Stringa Available when: type = sms
email Facoltativo Stringa Available when: type = email
whatsapp Facoltativo Stringa Available when: type = whatsapp
whatsapp_body Facoltativo Stringa Available when: type = whatsapp
facetime Facoltativo Stringa Available when: type = facetime
location
location_latitude Facoltativo Galleggiare Available when: type = location
location_longitude Facoltativo Galleggiare Available when: type = location
wifi
wifi_ssid Facoltativo Stringa Available when: type = wifi
wifi_encryption Facoltativo Stringa Valori consentiti: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Facoltativo Stringa Available when: type = wifi
wifi_is_hidden Facoltativo Booleano Available when: type = wifi
event Facoltativo Stringa Available when: type = event
event_location Facoltativo Stringa Available when: type = event
event_url Facoltativo Stringa Available when: type = event
event_note Facoltativo Stringa Available when: type = event
event_timezone Facoltativo Stringa Available when: type = event
event_start_datetime Facoltativo Stringa Available when: type = event
event_end_datetime Facoltativo Stringa Available when: type = event
event_first_alert_datetime Facoltativo Stringa Available when: type = event
event_second_alert_datetime Facoltativo Stringa Available when: type = event
crypto
crypto_coin Facoltativo Stringa Available when: type = crypto
crypto_address Facoltativo Stringa Available when: type = crypto
crypto_amount Facoltativo Stringa Available when: type = crypto
vcard
vcard_first_name Facoltativo Stringa Available when: type = vcard
vcard_last_name Facoltativo Stringa Available when: type = vcard
vcard_company Facoltativo Stringa Available when: type = vcard
vcard_phone_number_label[index] Facoltativo Stringa Available when: type = vcard
vcard_phone_number_value[index] Facoltativo Stringa Available when: type = vcard
vcard_email Facoltativo Stringa Available when: type = vcard
vcard_url Facoltativo Stringa Available when: type = vcard
vcard_job_title Facoltativo Stringa Available when: type = vcard
vcard_birthday Facoltativo Stringa Available when: type = vcard
vcard_street Facoltativo Stringa Available when: type = vcard
vcard_city Facoltativo Stringa Available when: type = vcard
vcard_zip Facoltativo Stringa Available when: type = vcard
vcard_region Facoltativo Stringa Available when: type = vcard
vcard_country Facoltativo Stringa Available when: type = vcard
vcard_note Facoltativo Stringa Available when: type = vcard
vcard_social_label[index] Facoltativo Stringa Available when: type = vcard
vcard_social_value[index] Facoltativo Stringa Available when: type = vcard
paypal
paypal_type Facoltativo Stringa Valori consentiti: buy_now, add_to_cart, donation (type=paypal)
paypal_email Facoltativo Stringa Available when: type = paypal
paypal_title Facoltativo Stringa Available when: type = paypal
paypal_currency Facoltativo Stringa Available when: type = paypal
paypal_price Facoltativo Galleggiare Available when: type = paypal
paypal_thank_you_url Facoltativo Stringa Available when: type = paypal
paypal_cancel_url Facoltativo Stringa Available when: type = paypal
upi
upi_payee_id Facoltativo Stringa Available when: type = upi
upi_payee_name Facoltativo Stringa Available when: type = upi
upi_currency Facoltativo Stringa Available when: type = upi
upi_amount Facoltativo Galleggiare Available when: type = upi
upi_transaction_id Facoltativo Stringa Available when: type = upi
upi_transaction_note Facoltativo Stringa Available when: type = upi
upi_transaction_reference Facoltativo Stringa Available when: type = upi
upi_thank_you_url Facoltativo Stringa Available when: type = upi
epc
epc_iban Facoltativo Stringa Available when: type = epc
epc_payee_name Facoltativo Stringa Available when: type = epc
epc_currency Facoltativo Stringa Available when: type = epc
epc_amount Facoltativo Galleggiare Available when: type = epc
epc_bic Facoltativo Stringa Available when: type = epc
epc_remittance_reference Facoltativo Stringa Available when: type = epc
epc_remittance_text Facoltativo Stringa Available when: type = epc
information Facoltativo Stringa Available when: type = epc
pix
pix_payee_key Facoltativo Stringa Available when: type = pix
pix_payee_name Facoltativo Stringa Available when: type = pix
pix_currency Facoltativo Stringa Available when: type = pix
pix_amount Facoltativo Galleggiare Available when: type = pix
pix_city Facoltativo Stringa Available when: type = pix
pix_transaction_id Facoltativo Stringa Available when: type = pix
pix_description Facoltativo Stringa Available when: type = pix
Parametri Dettagli Descrizione
curl --request POST \
--url 'https://sqr.co/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 } }

Aggiorna

POST https://sqr.co/api/qr-codes/{qr_code_id}
Parametri Dettagli Descrizione
link_id Facoltativo Intero -
project_id Facoltativo Stringa -
name Facoltativo Stringa -
type Facoltativo Stringa Valori consentiti: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
style Facoltativo Stringa Valori consentiti: square, dot, round, diamond, heart
inner_eye_style Facoltativo Stringa Valori consentiti: square, dot, rounded, diamond, flower, leaf
outer_eye_style Facoltativo Stringa Valori consentiti: square, circle, rounded, flower, leaf
foreground_type Facoltativo Stringa Valori consentiti: color, gradient
foreground_color Facoltativo Stringa Available when: foreground_type = color
foreground_gradient_style Facoltativo Stringa Valori consentiti: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Facoltativo Stringa Available when: foreground_type = gradient
foreground_gradient_two Facoltativo Stringa Available when: foreground_type = gradient
background_color Facoltativo Stringa
background_color_transparency Facoltativo Intero 0 - 100
custom_eyes_color Facoltativo Booleano
eyes_inner_color Facoltativo Stringa Available when: custom_eyes_color = 1
eyes_outer_color Facoltativo Stringa Available when: custom_eyes_color = 1
qr_code_logo Facoltativo File -
qr_code_logo_size Facoltativo Intero 5-35
qr_code_background Facoltativo File -
qr_code_background_transparency Facoltativo Intero 0-100
qr_code_foreground Facoltativo File -
qr_code_foreground_transparency Facoltativo Intero 0-100
frame Facoltativo Stringa Valori consentiti: 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 Facoltativo Stringa
frame_text_size Facoltativo Intero -5 -> 5
frame_text_font Facoltativo Stringa Valori consentiti: 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 Facoltativo Booleano
frame_color Facoltativo Stringa Available when: frame_custom_colors = 1
frame_text_color Facoltativo Stringa Available when: frame_custom_colors = 1
size Facoltativo Intero 50-2000
margin Facoltativo Intero 0-25
ecc Facoltativo Stringa Valori consentiti: L, M, Q, H
text Facoltativo Stringa Available when: type = text
url Facoltativo Stringa Available when: type = url
phone Facoltativo Stringa Available when: type = phone
sms Facoltativo Stringa Available when: type = sms
sms_body Facoltativo Stringa Available when: type = sms
email Facoltativo Stringa Available when: type = email
whatsapp Facoltativo Stringa Available when: type = whatsapp
whatsapp_body Facoltativo Stringa Available when: type = whatsapp
facetime Facoltativo Stringa Available when: type = facetime
location
location_latitude Facoltativo Galleggiare Available when: type = location
location_longitude Facoltativo Galleggiare Available when: type = location
wifi
wifi_ssid Facoltativo Stringa Available when: type = wifi
wifi_encryption Facoltativo Stringa Valori consentiti: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Facoltativo Stringa Available when: type = wifi
wifi_is_hidden Facoltativo Booleano Available when: type = wifi
event Facoltativo Stringa Available when: type = event
event_location Facoltativo Stringa Available when: type = event
event_url Facoltativo Stringa Available when: type = event
event_note Facoltativo Stringa Available when: type = event
event_timezone Facoltativo Stringa Available when: type = event
event_start_datetime Facoltativo Stringa Available when: type = event
event_end_datetime Facoltativo Stringa Available when: type = event
event_first_alert_datetime Facoltativo Stringa Available when: type = event
event_second_alert_datetime Facoltativo Stringa Available when: type = event
crypto
crypto_coin Facoltativo Stringa Available when: type = crypto
crypto_address Facoltativo Stringa Available when: type = crypto
crypto_amount Facoltativo Stringa Available when: type = crypto
vcard
vcard_first_name Facoltativo Stringa Available when: type = vcard
vcard_last_name Facoltativo Stringa Available when: type = vcard
vcard_company Facoltativo Stringa Available when: type = vcard
vcard_phone_number_label[index] Facoltativo Stringa Available when: type = vcard
vcard_phone_number_value[index] Facoltativo Stringa Available when: type = vcard
vcard_email Facoltativo Stringa Available when: type = vcard
vcard_url Facoltativo Stringa Available when: type = vcard
vcard_job_title Facoltativo Stringa Available when: type = vcard
vcard_birthday Facoltativo Stringa Available when: type = vcard
vcard_street Facoltativo Stringa Available when: type = vcard
vcard_city Facoltativo Stringa Available when: type = vcard
vcard_zip Facoltativo Stringa Available when: type = vcard
vcard_region Facoltativo Stringa Available when: type = vcard
vcard_country Facoltativo Stringa Available when: type = vcard
vcard_note Facoltativo Stringa Available when: type = vcard
vcard_social_label[index] Facoltativo Stringa Available when: type = vcard
vcard_social_value[index] Facoltativo Stringa Available when: type = vcard
paypal
paypal_type Facoltativo Stringa Valori consentiti: buy_now, add_to_cart, donation (type=paypal)
paypal_email Facoltativo Stringa Available when: type = paypal
paypal_title Facoltativo Stringa Available when: type = paypal
paypal_currency Facoltativo Stringa Available when: type = paypal
paypal_price Facoltativo Galleggiare Available when: type = paypal
paypal_thank_you_url Facoltativo Stringa Available when: type = paypal
paypal_cancel_url Facoltativo Stringa Available when: type = paypal
upi
upi_payee_id Facoltativo Stringa Available when: type = upi
upi_payee_name Facoltativo Stringa Available when: type = upi
upi_currency Facoltativo Stringa Available when: type = upi
upi_amount Facoltativo Galleggiare Available when: type = upi
upi_transaction_id Facoltativo Stringa Available when: type = upi
upi_transaction_note Facoltativo Stringa Available when: type = upi
upi_transaction_reference Facoltativo Stringa Available when: type = upi
upi_thank_you_url Facoltativo Stringa Available when: type = upi
epc
epc_iban Facoltativo Stringa Available when: type = epc
epc_payee_name Facoltativo Stringa Available when: type = epc
epc_currency Facoltativo Stringa Available when: type = epc
epc_amount Facoltativo Galleggiare Available when: type = epc
epc_bic Facoltativo Stringa Available when: type = epc
epc_remittance_reference Facoltativo Stringa Available when: type = epc
epc_remittance_text Facoltativo Stringa Available when: type = epc
information Facoltativo Stringa Available when: type = epc
pix
pix_payee_key Facoltativo Stringa Available when: type = pix
pix_payee_name Facoltativo Stringa Available when: type = pix
pix_currency Facoltativo Stringa Available when: type = pix
pix_amount Facoltativo Galleggiare Available when: type = pix
pix_city Facoltativo Stringa Available when: type = pix
pix_transaction_id Facoltativo Stringa Available when: type = pix
pix_description Facoltativo Stringa Available when: type = pix
curl --request POST \
--url 'https://sqr.co/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \
{ "data": { "id": 1 } }

Elimina

DELETE https://sqr.co/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://sqr.co/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \