QR-коды

GET https://sqr.co/api/qr-codes/
curl --request GET \
--url 'https://sqr.co/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Подробности Описание
page Необязательно Целое число Номер страницы, с которой вы хотите получить результаты. По умолчанию 1.
results_per_page Необязательно Целое число Сколько результатов вы хотите на странице. Допустимые значения: 10 , 25 , 50 , 100 , 250 , 500 , 1000. По умолчанию 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" } }
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" } }
POST https://sqr.co/api/qr-codes
Параметры Подробности Описание
link_id Необязательно Целое число -
project_id Необязательно Целое число -
name Требуется Строка -
type Требуется Строка Разрешенные значения: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
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
Параметры Подробности Описание
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 } }
POST https://sqr.co/api/qr-codes/{qr_code_id}
Параметры Подробности Описание
link_id Необязательно Целое число -
project_id Необязательно Строка -
name Необязательно Строка -
type Необязательно Строка Разрешенные значения: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
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://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 } }
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}' \