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, "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://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, "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://linktrle.com/api/qr-codes
Параметры Детали Описание
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 Опциональный Целое число
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 Опциональный Плавать Доступно, когда: 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
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
Параметры Детали Описание
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
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 Опциональный Плавать Доступно, когда: 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
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
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}' \