QR-коди

GET https://linktrle.com/api/qr-codes/
curl --request GET \
--url 'https://linktrle.com/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://linktrle.com/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://linktrle.com/api/qr-codes?&page=1", "last": "https://linktrle.com/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://linktrle.com/api/qr-codes?&page=1" } }
GET https://linktrle.com/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://linktrle.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://linktrle.com/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://linktrle.com/api/qr-codes
Параметри Деталі Опис
project_id Необов'язковий Ціле число -
name Обов'язково Рядок -
type Обов'язково Рядок Допустимі значення: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
is_bulk Необов'язковий Булевий Доступно, коли: 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 Необов'язковий Рядок Доступно, коли: 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
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, 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 Необов'язковий Дробове число Доступно, коли: type = location
location_longitude Необов'язковий Дробове число Доступно, коли: 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
event_first_alert_datetime Необов'язковий Рядок Доступно, коли: type = event
event_second_alert_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 Необов'язковий Дробове число Доступно, коли: 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 Необов'язковий Дробове число Доступно, коли: 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 Необов'язковий Дробове число Доступно, коли: 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 Необов'язковий Дробове число Доступно, коли: type = pix
pix_city Необов'язковий Рядок Доступно, коли: type = pix
pix_transaction_id Необов'язковий Рядок Доступно, коли: type = pix
pix_description Необов'язковий Рядок Доступно, коли: type = pix
Параметри Деталі Опис
curl --request POST \
--url 'https://linktrle.com/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://linktrle.com/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
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, 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 Необов'язковий Дробове число Доступно, коли: type = location
location_longitude Необов'язковий Дробове число Доступно, коли: 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
event_first_alert_datetime Необов'язковий Рядок Доступно, коли: type = event
event_second_alert_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 Необов'язковий Дробове число Доступно, коли: 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 Необов'язковий Дробове число Доступно, коли: 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 Необов'язковий Дробове число Доступно, коли: 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 Необов'язковий Дробове число Доступно, коли: type = pix
pix_city Необов'язковий Рядок Доступно, коли: type = pix
pix_transaction_id Необов'язковий Рядок Доступно, коли: type = pix
pix_description Необов'язковий Рядок Доступно, коли: type = pix
curl --request POST \
--url 'https://linktrle.com/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://linktrle.com/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://linktrle.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \