QR-коды

GET https://biopage.ru/api/qr-codes/
curl --request GET \
--url 'https://biopage.ru/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://biopage.ru/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://biopage.ru/api/qr-codes?&page=1", "last": "https://biopage.ru/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://biopage.ru/api/qr-codes?&page=1" } }
GET https://biopage.ru/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://biopage.ru/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://biopage.ru/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://biopage.ru/api/qr-codes
Параметры Подробности Описание
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 Необязательный Строка Доступно, когда: 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 Необязательный Целое число
custom_eyes_color Необязательный Логический
eyes_inner_color Необязательный Строка Доступно, когда: custom_eyes_color = 1
eyes_outer_color Необязательный Строка Доступно, когда: custom_eyes_color = 1
qr_code_logo Необязательный Файл -
qr_code_logo_size Необязательный Целое число 5-35
qr_code_background Необязательный Файл -
qr_code_background_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, lucida_console, monaco, comic_sans_ms, impact
frame_custom_colors Необязательный Логический
frame_color Необязательный Строка Доступно, когда: frame_custom_colors = 1
frame_text_color Необязательный Строка Доступно, когда: frame_custom_colors = 1
size Необязательный Целое число 50-2000
margin Необязательный Целое число 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 Необязательный Логический Доступно, когда: 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
pix
pix_payee_key Необязательный Строка Доступно, когда: type = pix
pix_payee_name Необязательный Строка Доступно, когда: type = pix
pix_currency Необязательный Строка Доступно, когда: type = pix
pix_amount Необязательный Float Доступно, когда: type = pix
pix_city Необязательный Строка Доступно, когда: type = pix
pix_transaction_id Необязательный Строка Доступно, когда: type = pix
pix_description Необязательный Строка Доступно, когда: type = pix
Параметры Подробности Описание
curl --request POST \
--url 'https://biopage.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://biopage.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, 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 Необязательный Строка Доступно, когда: 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 Необязательный Целое число 0 - 100
custom_eyes_color Необязательный Логический
eyes_inner_color Необязательный Строка Доступно, когда: custom_eyes_color = 1
eyes_outer_color Необязательный Строка Доступно, когда: custom_eyes_color = 1
qr_code_logo Необязательный Файл -
qr_code_logo_size Необязательный Целое число 5-35
qr_code_background Необязательный Файл -
qr_code_background_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, lucida_console, monaco, comic_sans_ms, impact
frame_custom_colors Необязательный Логический
frame_color Необязательный Строка Доступно, когда: frame_custom_colors = 1
frame_text_color Необязательный Строка Доступно, когда: frame_custom_colors = 1
size Необязательный Целое число 50-2000
margin Необязательный Целое число 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 Необязательный Логический Доступно, когда: 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
pix
pix_payee_key Необязательный Строка Доступно, когда: type = pix
pix_payee_name Необязательный Строка Доступно, когда: type = pix
pix_currency Необязательный Строка Доступно, когда: type = pix
pix_amount Необязательный Float Доступно, когда: type = pix
pix_city Необязательный Строка Доступно, когда: type = pix
pix_transaction_id Необязательный Строка Доступно, когда: type = pix
pix_description Необязательный Строка Доступно, когда: type = pix
curl --request POST \
--url 'https://biopage.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://biopage.ru/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://biopage.ru/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \