QR-коды

Получить все

GET https://yoolink.ru/api/qr-codes/
curl --request GET \
--url 'https://yoolink.ru/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Детали Описание
page Опционально Integer Номер страницы, с которой вы хотите получить результат. По умолчанию 1.
results_per_page Опционально Integer Сколько результатов на странице. Допустимые значения: 10 , 25 , 50 , 100 , 250 , 500 , 1000. По умолчанию 25.
{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://yoolink.ru/uploads/qr_code/example.svg", "qr_code_logo": 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" }, "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://yoolink.ru/api/qr-codes?&page=1", "last": "https://yoolink.ru/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://yoolink.ru/api/qr-codes?&page=1" } }

Получить один

GET https://yoolink.ru/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://yoolink.ru/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://yoolink.ru/uploads/qr_code/example.svg", "qr_code_logo": 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" }, "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" } }

Создать

POST https://yoolink.ru/api/qr-codes
Параметры Детали Описание
project_id Опционально Integer -
name Обязательно Строка -
type Обязательно Строка Допустимые значения: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc
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 Опционально Строка Доступно, когда: foreground_type = color
foreground_gradient_style Опционально Строка Допустимые значения: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Опционально Строка Доступно, когда: foreground_type = gradient
foreground_gradient_two Опционально Строка Доступно, когда: foreground_type = gradient
background_color Опционально Строка
background_color_transparency Опционально Integer
custom_eyes_color Опционально Boolean
eyes_inner_color Опционально Строка Доступно, когда: custom_eyes_color = 1
eyes_outer_color Опционально Строка Доступно, когда: custom_eyes_color = 1
qr_code_logo Опционально File -
qr_code_logo_size Опционально Integer 5-35
qr_code_background Опционально File -
qr_code_background_transparency Опционально Integer 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 Опционально Integer -5 - 5
frame_text_font Опционально Строка Допустимые значения: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, lucida_console, monaco, comic_sans_ms, impact
frame_custom_colors Опционально Boolean
frame_color Опционально Строка Доступно, когда: frame_custom_colors = 1
frame_text_color Опционально Строка Доступно, когда: frame_custom_colors = 1
size Опционально Integer 50-2000
margin Опционально Integer 0-25
ecc Опционально Строка Допустимые значения: L, M, Q, H
text Опционально Строка Доступно, когда: type = text
url Опционально Строка Доступно, когда: type = url
phone Опционально Строка Доступно, когда: type = phone
sms Опционально Строка Доступно, когда: type = sms
sms_body Опционально Строка Доступно, когда: type = sms
email Опционально Строка Доступно, когда: type = email
whatsapp Опционально Строка Доступно, когда: type = whatsapp
whatsapp_body Опционально Строка Доступно, когда: type = whatsapp
facetime Опционально Строка Доступно, когда: type = facetime
location
location_latitude Опционально Float Доступно, когда: type = location
location_longitude Опционально Float Доступно, когда: type = location
wifi
wifi_ssid Опционально Строка Доступно, когда: type = wifi
wifi_encryption Опционально Строка Допустимые значения: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Опционально Строка Доступно, когда: type = wifi
wifi_is_hidden Опционально Boolean Доступно, когда: type = wifi
event Опционально Строка Доступно, когда: type = event
event_location Опционально Строка Доступно, когда: type = event
event_url Опционально Строка Доступно, когда: type = event
event_note Опционально Строка Доступно, когда: type = event
event_timezone Опционально Строка Доступно, когда: type = event
event_start_datetime Опционально Строка Доступно, когда: type = event
event_end_datetime Опционально Строка Доступно, когда: type = event
crypto
crypto_coin Опционально Строка Доступно, когда: type = crypto
crypto_address Опционально Строка Доступно, когда: type = crypto
crypto_amount Опционально Строка Доступно, когда: type = crypto
vcard
vcard_first_name Опционально Строка Доступно, когда: type = vcard
vcard_last_name Опционально Строка Доступно, когда: type = vcard
vcard_company Опционально Строка Доступно, когда: type = vcard
vcard_phone_number_label[index] Опционально Строка Доступно, когда: type = vcard
vcard_phone_number_value[index] Опционально Строка Доступно, когда: type = vcard
vcard_email Опционально Строка Доступно, когда: type = vcard
vcard_url Опционально Строка Доступно, когда: type = vcard
vcard_job_title Опционально Строка Доступно, когда: type = vcard
vcard_birthday Опционально Строка Доступно, когда: type = vcard
vcard_street Опционально Строка Доступно, когда: type = vcard
vcard_city Опционально Строка Доступно, когда: type = vcard
vcard_zip Опционально Строка Доступно, когда: type = vcard
vcard_region Опционально Строка Доступно, когда: type = vcard
vcard_country Опционально Строка Доступно, когда: type = vcard
vcard_note Опционально Строка Доступно, когда: type = vcard
vcard_social_label[index] Опционально Строка Доступно, когда: type = vcard
vcard_social_value[index] Опционально Строка Доступно, когда: type = vcard
paypal
paypal_type Опционально Строка Допустимые значения: buy_now, add_to_cart, donation (type=paypal)
paypal_email Опционально Строка Доступно, когда: type = paypal
paypal_title Опционально Строка Доступно, когда: type = paypal
paypal_currency Опционально Строка Доступно, когда: type = paypal
paypal_price Опционально Float Доступно, когда: type = paypal
paypal_thank_you_url Опционально Строка Доступно, когда: type = paypal
paypal_cancel_url Опционально Строка Доступно, когда: type = paypal
upi
upi_payee_id Опционально Строка Доступно, когда: type = upi
upi_payee_name Опционально Строка Доступно, когда: type = upi
upi_currency Опционально Строка Доступно, когда: type = upi
upi_amount Опционально Float Доступно, когда: type = upi
upi_transaction_id Опционально Строка Доступно, когда: type = upi
upi_transaction_note Опционально Строка Доступно, когда: type = upi
upi_transaction_reference Опционально Строка Доступно, когда: type = upi
upi_thank_you_url Опционально Строка Доступно, когда: type = upi
epc
epc_iban Опционально Строка Доступно, когда: type = epc
epc_payee_name Опционально Строка Доступно, когда: type = epc
epc_currency Опционально Строка Доступно, когда: type = epc
epc_amount Опционально Float Доступно, когда: type = epc
epc_bic Опционально Строка Доступно, когда: type = epc
epc_remittance_reference Опционально Строка Доступно, когда: type = epc
epc_remittance_text Опционально Строка Доступно, когда: type = epc
information Опционально Строка Доступно, когда: type = epc
Параметры Детали Описание
curl --request POST \
--url 'https://yoolink.ru/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://yoolink.ru/api/qr-codes/{qr_code_id}
Параметры Детали Описание
project_id Опционально Строка -
name Опционально Строка -
type Опционально Строка Допустимые значения: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc
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 Опционально Строка Доступно, когда: foreground_type = color
foreground_gradient_style Опционально Строка Допустимые значения: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Опционально Строка Доступно, когда: foreground_type = gradient
foreground_gradient_two Опционально Строка Доступно, когда: foreground_type = gradient
background_color Опционально Строка
background_color_transparency Опционально Integer 0 - 100
custom_eyes_color Опционально Boolean
eyes_inner_color Опционально Строка Доступно, когда: custom_eyes_color = 1
eyes_outer_color Опционально Строка Доступно, когда: custom_eyes_color = 1
qr_code_logo Опционально File -
qr_code_logo_size Опционально Integer 5-35
qr_code_background Опционально File -
qr_code_background_transparency Опционально Integer 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 Опционально Integer -5 -> 5
frame_text_font Опционально Строка Допустимые значения: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, lucida_console, monaco, comic_sans_ms, impact
frame_custom_colors Опционально Boolean
frame_color Опционально Строка Доступно, когда: frame_custom_colors = 1
frame_text_color Опционально Строка Доступно, когда: frame_custom_colors = 1
size Опционально Integer 50-2000
margin Опционально Integer 0-25
ecc Опционально Строка Допустимые значения: L, M, Q, H
text Опционально Строка Доступно, когда: type = text
url Опционально Строка Доступно, когда: type = url
phone Опционально Строка Доступно, когда: type = phone
sms Опционально Строка Доступно, когда: type = sms
sms_body Опционально Строка Доступно, когда: type = sms
email Опционально Строка Доступно, когда: type = email
whatsapp Опционально Строка Доступно, когда: type = whatsapp
whatsapp_body Опционально Строка Доступно, когда: type = whatsapp
facetime Опционально Строка Доступно, когда: type = facetime
location
location_latitude Опционально Float Доступно, когда: type = location
location_longitude Опционально Float Доступно, когда: type = location
wifi
wifi_ssid Опционально Строка Доступно, когда: type = wifi
wifi_encryption Опционально Строка Допустимые значения: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Опционально Строка Доступно, когда: type = wifi
wifi_is_hidden Опционально Boolean Доступно, когда: type = wifi
event Опционально Строка Доступно, когда: type = event
event_location Опционально Строка Доступно, когда: type = event
event_url Опционально Строка Доступно, когда: type = event
event_note Опционально Строка Доступно, когда: type = event
event_timezone Опционально Строка Доступно, когда: type = event
event_start_datetime Опционально Строка Доступно, когда: type = event
event_end_datetime Опционально Строка Доступно, когда: type = event
crypto
crypto_coin Опционально Строка Доступно, когда: type = crypto
crypto_address Опционально Строка Доступно, когда: type = crypto
crypto_amount Опционально Строка Доступно, когда: type = crypto
vcard
vcard_first_name Опционально Строка Доступно, когда: type = vcard
vcard_last_name Опционально Строка Доступно, когда: type = vcard
vcard_company Опционально Строка Доступно, когда: type = vcard
vcard_phone_number_label[index] Опционально Строка Доступно, когда: type = vcard
vcard_phone_number_value[index] Опционально Строка Доступно, когда: type = vcard
vcard_email Опционально Строка Доступно, когда: type = vcard
vcard_url Опционально Строка Доступно, когда: type = vcard
vcard_job_title Опционально Строка Доступно, когда: type = vcard
vcard_birthday Опционально Строка Доступно, когда: type = vcard
vcard_street Опционально Строка Доступно, когда: type = vcard
vcard_city Опционально Строка Доступно, когда: type = vcard
vcard_zip Опционально Строка Доступно, когда: type = vcard
vcard_region Опционально Строка Доступно, когда: type = vcard
vcard_country Опционально Строка Доступно, когда: type = vcard
vcard_note Опционально Строка Доступно, когда: type = vcard
vcard_social_label[index] Опционально Строка Доступно, когда: type = vcard
vcard_social_value[index] Опционально Строка Доступно, когда: type = vcard
paypal
paypal_type Опционально Строка Допустимые значения: buy_now, add_to_cart, donation (type=paypal)
paypal_email Опционально Строка Доступно, когда: type = paypal
paypal_title Опционально Строка Доступно, когда: type = paypal
paypal_currency Опционально Строка Доступно, когда: type = paypal
paypal_price Опционально Float Доступно, когда: type = paypal
paypal_thank_you_url Опционально Строка Доступно, когда: type = paypal
paypal_cancel_url Опционально Строка Доступно, когда: type = paypal
upi
upi_payee_id Опционально Строка Доступно, когда: type = upi
upi_payee_name Опционально Строка Доступно, когда: type = upi
upi_currency Опционально Строка Доступно, когда: type = upi
upi_amount Опционально Float Доступно, когда: type = upi
upi_transaction_id Опционально Строка Доступно, когда: type = upi
upi_transaction_note Опционально Строка Доступно, когда: type = upi
upi_transaction_reference Опционально Строка Доступно, когда: type = upi
upi_thank_you_url Опционально Строка Доступно, когда: type = upi
epc
epc_iban Опционально Строка Доступно, когда: type = epc
epc_payee_name Опционально Строка Доступно, когда: type = epc
epc_currency Опционально Строка Доступно, когда: type = epc
epc_amount Опционально Float Доступно, когда: type = epc
epc_bic Опционально Строка Доступно, когда: type = epc
epc_remittance_reference Опционально Строка Доступно, когда: type = epc
epc_remittance_text Опционально Строка Доступно, когда: type = epc
information Опционально Строка Доступно, когда: type = epc
curl --request POST \
--url 'https://yoolink.ru/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://yoolink.ru/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://yoolink.ru/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \