→ Short Links & QR codes for Agencies

Codes QR

Récupérer tout

GET https://sqr.co/api/qr-codes/
curl --request GET \
--url 'https://sqr.co/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
page Facultatif Entier Le numéro de page à partir duquel vous souhaitez obtenir des résultats. Par défaut à 1.
results_per_page Facultatif Entier Combien de résultats voulez-vous par page. Les valeurs autorisées sont : 10 , 25 , 50 , 100 , 250 , 500 , 1000. Par défaut à 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" } }

Récupérer un

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" } }

Créer

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

Mettre à jour

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

Supprimer

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}' \