API sənədləri
QR kodlar
QR kodları siyahılayın, baxın, yaradın, yeniləyin və silin.
Autentifikasiya
Hər sorğu admin API açarına uyğun Bearer token ilə Authorization başlığını göndərməlidir.
API açarını əldə et.
Son nöqtə
GET https://rqrcode.com/api/qr-codes/
Nümunə
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}'
Parametrlər
| Parametrlər | Detallar | Təsvir |
|---|---|---|
| page |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
Nəticələri almaq üçün istifadə olunan səhifə nömrəsi. Defolt olaraq 1. |
| results_per_page |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
Hər səhifədə nəticələrin sayı. İcazə verilən dəyərlər: 10, 25, 50, 100, 250, 500, 1000. Defolt olaraq 25. |
Cavab nümunəsi
{
"data": [
{
"id": 1,
"type": "url",
"name": "Nümunə ad",
"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"
}
}
Son nöqtə
GET https://rqrcode.com/api/qr-codes/{qr_code_id}
Nümunə
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
Parametrlər
Əlavə parametr yoxdur.
Cavab nümunəsi
{
"data": {
"id": 1,
"type": "url",
"name": "Nümunə ad",
"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"
}
}
Son nöqtə
POST https://rqrcode.com/api/qr-codes
Nümunə
curl --request POST \
--url 'https://rqrcode.com/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Nyu-York' \
--form 'type=text' \
--form 'text=Salam!'
Parametrlər
| Parametrlər | Detallar | Təsvir |
|---|---|---|
| link_id |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| project_id |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| name |
Tələb olunur
ui.admin.api_docs.common.types.Mətn
|
- |
| type |
Tələb olunur
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix, coupon, google_review |
| is_bulk |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
Bu halda mövcuddur: type = text |
| style |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: 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 |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: square, dot, rounded, diamond, flower, leaf |
| outer_eye_style |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: square, circle, rounded, flower, leaf |
| foreground_type |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: color, gradient |
| foreground_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: foreground_type = color |
| foreground_gradient_style |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: vertical, horizontal, diagonal, inverse_diagonal, radial |
| foreground_gradient_one |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: foreground_type = gradient |
| foreground_gradient_two |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: foreground_type = gradient |
| background_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| background_color_transparency |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| custom_eyes_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| eyes_inner_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: custom_eyes_color = 1 |
| eyes_outer_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: custom_eyes_color = 1 |
| qr_code_logo |
İstəyə bağlı
ui.admin.api_docs.common.types.Fayl
|
- |
| qr_code_logo_size |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
5-35 |
| qr_code_background |
İstəyə bağlı
ui.admin.api_docs.common.types.Fayl
|
- |
| qr_code_background_transparency |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
0-100 |
| qr_code_foreground |
İstəyə bağlı
ui.admin.api_docs.common.types.Fayl
|
- |
| qr_code_foreground_transparency |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
0-100 |
| frame |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: 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 |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| frame_text_size |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
-5 - 5 |
| frame_text_font |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: 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 |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| frame_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: frame_custom_colors = 1 |
| frame_text_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: frame_custom_colors = 1 |
| size |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
50-2000 |
| margin |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
0-25 |
| ecc |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: L, M, Q, H |
| text |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = text |
| url |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = url |
| phone |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = phone |
| sms |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = sms |
|
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = email | |
|
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = whatsapp | |
| facetime |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = facetime |
| event |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = event |
| location |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| wifi |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| crypto |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| vcard |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| paypal |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| upi |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| epc |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| pix |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| coupon |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| google_review |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
Cavab nümunəsi
{
"data": {
"id": 1
}
}
Son nöqtə
POST https://rqrcode.com/api/qr-codes/{qr_code_id}
Nümunə
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-Veqas'
Parametrlər
| Parametrlər | Detallar | Təsvir |
|---|---|---|
| link_id |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| project_id |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| name |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| type |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix, coupon, google_review |
| style |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: 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 |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: square, dot, rounded, diamond, flower, leaf |
| outer_eye_style |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: square, circle, rounded, flower, leaf |
| foreground_type |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: color, gradient |
| foreground_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: foreground_type = color |
| foreground_gradient_style |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: vertical, horizontal, diagonal, inverse_diagonal, radial |
| foreground_gradient_one |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: foreground_type = gradient |
| foreground_gradient_two |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: foreground_type = gradient |
| background_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| background_color_transparency |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
0 - 100 |
| custom_eyes_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| eyes_inner_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: custom_eyes_color = 1 |
| eyes_outer_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: custom_eyes_color = 1 |
| qr_code_logo |
İstəyə bağlı
ui.admin.api_docs.common.types.Fayl
|
- |
| qr_code_logo_size |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
5-35 |
| qr_code_background |
İstəyə bağlı
ui.admin.api_docs.common.types.Fayl
|
- |
| qr_code_background_transparency |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
0-100 |
| qr_code_foreground |
İstəyə bağlı
ui.admin.api_docs.common.types.Fayl
|
- |
| qr_code_foreground_transparency |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
0-100 |
| frame |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: 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 |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| frame_text_size |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
-5 -> 5 |
| frame_text_font |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: 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 |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| frame_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: frame_custom_colors = 1 |
| frame_text_color |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: frame_custom_colors = 1 |
| size |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
50-2000 |
| margin |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
0-25 |
| ecc |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: L, M, Q, H |
| text |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = text |
| url |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = url |
| phone |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = phone |
| sms |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = sms |
|
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = email | |
|
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = whatsapp | |
| facetime |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = facetime |
| event |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: type = event |
| location |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| wifi |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| crypto |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| vcard |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| paypal |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| upi |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| epc |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| pix |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| coupon |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
| google_review |
İstəyə bağlı
ui.admin.api_docs.common.types.Obyekt
|
- |
Cavab nümunəsi
{
"data": {
"id": 1
}
}
Son nöqtə
DELETE https://rqrcode.com/api/qr-codes/{qr_code_id}
Nümunə
curl --request DELETE \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
Parametrlər
Əlavə parametr yoxdur.
Cavab nümunəsi
Uğurlu olduqda boş 200 cavab gövdəsi.