API dokumentacija
QR kodai
Išvardykite, peržiūrėkite, kurkite, atnaujinkite ir trinkite savo QR kodus.
Autentifikavimas
Kiekviena užklausa turi siųsti Authorization antraštę su Bearer žetonu, atitinkančiu administratoriaus API raktą.
Gauti API raktą.
Galinis taškas
GET https://rqrcode.com/api/qr-codes/
Pavyzdys
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}'
Parametrai
| Parametrai | Išsamiau | Aprašymas |
|---|---|---|
| page |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
Puslapio numeris, kurio rezultatus norite gauti. Numatytoji reikšmė yra 1. |
| results_per_page |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
Kiek rezultatų rodyti viename puslapyje. Leistinos reikšmės: 10, 25, 50, 100, 250, 500, 1000. Numatytoji reikšmė yra 25. |
Atsakymo pavyzdys
{
"data": [
{
"id": 1,
"type": "url",
"name": "Pavyzdinis pavadinimas",
"qr_code": "https://rqrcode.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": null,
"datetime": "2026-04-20 07:52:15"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://rqrcode.com/api/qr-codes?page=1",
"last": "https://rqrcode.com/api/qr-codes?page=1",
"next": null,
"prev": null,
"self": "https://rqrcode.com/api/qr-codes?page=1"
}
}
Galinis taškas
GET https://rqrcode.com/api/qr-codes/{qr_code_id}
Pavyzdys
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
Parametrai
Papildomų parametrų nėra.
Atsakymo pavyzdys
{
"data": {
"id": 1,
"type": "url",
"name": "Pavyzdinis pavadinimas",
"qr_code": "https://rqrcode.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": null,
"datetime": "2026-04-20 07:52:15"
}
}
Galinis taškas
POST https://rqrcode.com/api/qr-codes
Pavyzdys
curl --request POST \
--url 'https://rqrcode.com/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Niujorkas' \
--form 'type=text' \
--form 'text=Sveiki!'
Parametrai
| Parametrai | Išsamiau | Aprašymas |
|---|---|---|
| link_id |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
- |
| project_id |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
- |
| name |
Privaloma
ui.admin.api_docs.common.types.Eilutė
|
- |
| type |
Privaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix, coupon, google_review |
| is_bulk |
Neprivaloma
ui.admin.api_docs.common.types.Loginė reikšmė
|
Pasiekiama, kai: type = text |
| style |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: 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 |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: square, dot, rounded, diamond, flower, leaf |
| outer_eye_style |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: square, circle, rounded, flower, leaf |
| foreground_type |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: color, gradient |
| foreground_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: foreground_type = color |
| foreground_gradient_style |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: vertical, horizontal, diagonal, inverse_diagonal, radial |
| foreground_gradient_one |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: foreground_type = gradient |
| foreground_gradient_two |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: foreground_type = gradient |
| background_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
- |
| background_color_transparency |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
- |
| custom_eyes_color |
Neprivaloma
ui.admin.api_docs.common.types.Loginė reikšmė
|
- |
| eyes_inner_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: custom_eyes_color = 1 |
| eyes_outer_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: custom_eyes_color = 1 |
| qr_code_logo |
Neprivaloma
ui.admin.api_docs.common.types.Failas
|
- |
| qr_code_logo_size |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
5-35 |
| qr_code_background |
Neprivaloma
ui.admin.api_docs.common.types.Failas
|
- |
| qr_code_background_transparency |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
0-100 |
| qr_code_foreground |
Neprivaloma
ui.admin.api_docs.common.types.Failas
|
- |
| qr_code_foreground_transparency |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
0-100 |
| frame |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: 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 |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
- |
| frame_text_size |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
-5 - 5 |
| frame_text_font |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: 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 |
Neprivaloma
ui.admin.api_docs.common.types.Loginė reikšmė
|
- |
| frame_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: frame_custom_colors = 1 |
| frame_text_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: frame_custom_colors = 1 |
| size |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
50-2000 |
| margin |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
0-25 |
| ecc |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: L, M, Q, H |
| text |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = text |
| url |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = url |
| phone |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = phone |
| sms |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = sms |
|
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = email | |
|
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = whatsapp | |
| facetime |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = facetime |
| event |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = event |
| location |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| wifi |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| crypto |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| vcard |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| paypal |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| upi |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| epc |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| pix |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| coupon |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| google_review |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
Atsakymo pavyzdys
{
"data": {
"id": 1
}
}
Galinis taškas
POST https://rqrcode.com/api/qr-codes/{qr_code_id}
Pavyzdys
curl --request POST \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegasas'
Parametrai
| Parametrai | Išsamiau | Aprašymas |
|---|---|---|
| link_id |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
- |
| project_id |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
- |
| name |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
- |
| type |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix, coupon, google_review |
| style |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: 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 |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: square, dot, rounded, diamond, flower, leaf |
| outer_eye_style |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: square, circle, rounded, flower, leaf |
| foreground_type |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: color, gradient |
| foreground_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: foreground_type = color |
| foreground_gradient_style |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: vertical, horizontal, diagonal, inverse_diagonal, radial |
| foreground_gradient_one |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: foreground_type = gradient |
| foreground_gradient_two |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: foreground_type = gradient |
| background_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
- |
| background_color_transparency |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
0 - 100 |
| custom_eyes_color |
Neprivaloma
ui.admin.api_docs.common.types.Loginė reikšmė
|
- |
| eyes_inner_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: custom_eyes_color = 1 |
| eyes_outer_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: custom_eyes_color = 1 |
| qr_code_logo |
Neprivaloma
ui.admin.api_docs.common.types.Failas
|
- |
| qr_code_logo_size |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
5-35 |
| qr_code_background |
Neprivaloma
ui.admin.api_docs.common.types.Failas
|
- |
| qr_code_background_transparency |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
0-100 |
| qr_code_foreground |
Neprivaloma
ui.admin.api_docs.common.types.Failas
|
- |
| qr_code_foreground_transparency |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
0-100 |
| frame |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: 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 |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
- |
| frame_text_size |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
-5 -> 5 |
| frame_text_font |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: 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 |
Neprivaloma
ui.admin.api_docs.common.types.Loginė reikšmė
|
- |
| frame_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: frame_custom_colors = 1 |
| frame_text_color |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: frame_custom_colors = 1 |
| size |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
50-2000 |
| margin |
Neprivaloma
ui.admin.api_docs.common.types.Sveikasis skaičius
|
0-25 |
| ecc |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Leistinos reikšmės: L, M, Q, H |
| text |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = text |
| url |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = url |
| phone |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = phone |
| sms |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = sms |
|
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = email | |
|
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = whatsapp | |
| facetime |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = facetime |
| event |
Neprivaloma
ui.admin.api_docs.common.types.Eilutė
|
Pasiekiama, kai: type = event |
| location |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| wifi |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| crypto |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| vcard |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| paypal |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| upi |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| epc |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| pix |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| coupon |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
| google_review |
Neprivaloma
ui.admin.api_docs.common.types.Objektas
|
- |
Atsakymo pavyzdys
{
"data": {
"id": 1
}
}
Galinis taškas
DELETE https://rqrcode.com/api/qr-codes/{qr_code_id}
Pavyzdys
curl --request DELETE \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
Parametrai
Papildomų parametrų nėra.
Atsakymo pavyzdys
Sėkmės atveju grąžinamas tuščias 200 atsakymo turinys.