→ Short Links & QR codes for Agencies

QR-codes

Haal alles op

GET https://sqr.co/api/qr-codes/
curl --request GET \
--url 'https://sqr.co/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Beschrijving
page Optioneel Geheel getal Het paginanummer waarvan u resultaten wilt. Standaard ingesteld op 1.
results_per_page Optioneel Geheel getal Hoeveel resultaten wil je per pagina. Toegestane waarden zijn: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Standaard ingesteld op 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" } }

Haal er een op

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

Maak

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

Bijwerken

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

Verwijder

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