QR кодтары

GET https://links.kodx.uk/api/qr-codes/
curl --request GET \
--url 'https://links.kodx.uk/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://links.kodx.uk/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": null, "datetime": "2026-10-13 20:56:07" }, ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://links.kodx.uk/api/qr-codes?&page=1", "last": "https://links.kodx.uk/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://links.kodx.uk/api/qr-codes?&page=1" } }
GET https://links.kodx.uk/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://links.kodx.uk/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://links.kodx.uk/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": null, "datetime": "2026-10-13 20:56:07" } }
POST https://links.kodx.uk/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 Ихтималлы Строка
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 Ихтималлы Строка Рөхсәт ителгән ҡиммәттәр: circle_simple_bottom_text, round_simple_bottom_text, straight_simple_bottom_text, round_card_bottom_text, straight_bottom_text, straight_top_text, 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, straight_semi_bordered_bottom_text, round_semi_bordered_bottom_text, hand_arrows_bottom_text, broken_ticket_bottom_text, smooth_ribbon_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 Ихтималлы Строка Ҡайҙа: 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://links.kodx.uk/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://links.kodx.uk/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, rounded, elastic_square, heart, diamond, star, triangle, hexagon, spaced_square, octagon, cross_x, curvy_x, rounded_cross, ninja, sun, shine, bold_plus, teardrop, corner_cut, randomized_square, bold_x
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 Ихтималлы Строка Рөхсәт ителгән ҡиммәттәр: circle_simple_bottom_text, round_simple_bottom_text, straight_simple_bottom_text, round_card_bottom_text, straight_bottom_text, straight_top_text, 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, straight_semi_bordered_bottom_text, round_semi_bordered_bottom_text, hand_arrows_bottom_text, broken_ticket_bottom_text, smooth_ribbon_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 Ихтималлы Строка Ҡайҙа: 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://links.kodx.uk/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://links.kodx.uk/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://links.kodx.uk/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \