API दस्तऐवजीकरण
QR कोड
तुमचे QR कोड सूचीबद्ध करा, तपासा, तयार करा, अद्यतनित करा आणि हटवा.
प्रमाणीकरण
प्रत्येक request ने admin API key शी जुळणारा Bearer token असलेला Authorization header पाठवला पाहिजे.
API की मिळवा.
एंडपॉइंट
GET https://rqrcode.com/api/qr-codes/
उदाहरण
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}'
परिमाणे
| परिमाणे | तपशील | वर्णन |
|---|---|---|
| page |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
ज्या पृष्ठासाठी परिणाम हवे आहेत तो पृष्ठ क्रमांक. डीफॉल्ट 1. |
| results_per_page |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
प्रति पृष्ठ किती परिणाम हवेत. परवानगी असलेली मूल्ये: 10, 25, 50, 100, 250, 500, 1000. डीफॉल्ट 25. |
प्रतिसाद उदाहरण
{
"data": [
{
"id": 1,
"type": "url",
"name": "उदाहरण नाव",
"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"
}
}
एंडपॉइंट
GET https://rqrcode.com/api/qr-codes/{qr_code_id}
उदाहरण
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
परिमाणे
अतिरिक्त parameter नाही.
प्रतिसाद उदाहरण
{
"data": {
"id": 1,
"type": "url",
"name": "उदाहरण नाव",
"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"
}
}
एंडपॉइंट
POST https://rqrcode.com/api/qr-codes
उदाहरण
curl --request POST \
--url 'https://rqrcode.com/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=न्यूयॉर्क' \
--form 'type=text' \
--form 'text=नमस्कार!'
परिमाणे
| परिमाणे | तपशील | वर्णन |
|---|---|---|
| link_id |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
वर्णन नाही |
| project_id |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
वर्णन नाही |
| name |
आवश्यक
ui.admin.api_docs.common.types.स्ट्रिंग
|
वर्णन नाही |
| type |
आवश्यक
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix, coupon, google_review |
| is_bulk |
पर्यायी
ui.admin.api_docs.common.types.बूलियन
|
उपलब्ध जेव्हा: type = text |
| style |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: 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 |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: square, dot, rounded, diamond, flower, leaf |
| outer_eye_style |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: square, circle, rounded, flower, leaf |
| foreground_type |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: color, gradient |
| foreground_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: foreground_type = color |
| foreground_gradient_style |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: vertical, horizontal, diagonal, inverse_diagonal, radial |
| foreground_gradient_one |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: foreground_type = gradient |
| foreground_gradient_two |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: foreground_type = gradient |
| background_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
वर्णन नाही |
| background_color_transparency |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
वर्णन नाही |
| custom_eyes_color |
पर्यायी
ui.admin.api_docs.common.types.बूलियन
|
वर्णन नाही |
| eyes_inner_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: custom_eyes_color = 1 |
| eyes_outer_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: custom_eyes_color = 1 |
| qr_code_logo |
पर्यायी
ui.admin.api_docs.common.types.फाइल
|
वर्णन नाही |
| qr_code_logo_size |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
5-35 |
| qr_code_background |
पर्यायी
ui.admin.api_docs.common.types.फाइल
|
वर्णन नाही |
| qr_code_background_transparency |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
0-100 |
| qr_code_foreground |
पर्यायी
ui.admin.api_docs.common.types.फाइल
|
वर्णन नाही |
| qr_code_foreground_transparency |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
0-100 |
| frame |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: 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 |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
वर्णन नाही |
| frame_text_size |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
-5 - 5 |
| frame_text_font |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: 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 |
पर्यायी
ui.admin.api_docs.common.types.बूलियन
|
वर्णन नाही |
| frame_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: frame_custom_colors = 1 |
| frame_text_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: frame_custom_colors = 1 |
| size |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
50-2000 |
| margin |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
0-25 |
| ecc |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: L, M, Q, H |
| text |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = text |
| url |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = url |
| phone |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = phone |
| sms |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = sms |
|
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = email | |
|
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = whatsapp | |
| facetime |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = facetime |
| event |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = event |
| location |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| wifi |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| crypto |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| vcard |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| paypal |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| upi |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| epc |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| pix |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| coupon |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| google_review |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
प्रतिसाद उदाहरण
{
"data": {
"id": 1
}
}
एंडपॉइंट
POST https://rqrcode.com/api/qr-codes/{qr_code_id}
उदाहरण
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=लास वेगास'
परिमाणे
| परिमाणे | तपशील | वर्णन |
|---|---|---|
| link_id |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
वर्णन नाही |
| project_id |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
वर्णन नाही |
| name |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
वर्णन नाही |
| type |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix, coupon, google_review |
| style |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: 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 |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: square, dot, rounded, diamond, flower, leaf |
| outer_eye_style |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: square, circle, rounded, flower, leaf |
| foreground_type |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: color, gradient |
| foreground_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: foreground_type = color |
| foreground_gradient_style |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: vertical, horizontal, diagonal, inverse_diagonal, radial |
| foreground_gradient_one |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: foreground_type = gradient |
| foreground_gradient_two |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: foreground_type = gradient |
| background_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
वर्णन नाही |
| background_color_transparency |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
0 - 100 |
| custom_eyes_color |
पर्यायी
ui.admin.api_docs.common.types.बूलियन
|
वर्णन नाही |
| eyes_inner_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: custom_eyes_color = 1 |
| eyes_outer_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: custom_eyes_color = 1 |
| qr_code_logo |
पर्यायी
ui.admin.api_docs.common.types.फाइल
|
वर्णन नाही |
| qr_code_logo_size |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
5-35 |
| qr_code_background |
पर्यायी
ui.admin.api_docs.common.types.फाइल
|
वर्णन नाही |
| qr_code_background_transparency |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
0-100 |
| qr_code_foreground |
पर्यायी
ui.admin.api_docs.common.types.फाइल
|
वर्णन नाही |
| qr_code_foreground_transparency |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
0-100 |
| frame |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: 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 |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
वर्णन नाही |
| frame_text_size |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
-5 -> 5 |
| frame_text_font |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: 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 |
पर्यायी
ui.admin.api_docs.common.types.बूलियन
|
वर्णन नाही |
| frame_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: frame_custom_colors = 1 |
| frame_text_color |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: frame_custom_colors = 1 |
| size |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
50-2000 |
| margin |
पर्यायी
ui.admin.api_docs.common.types.पूर्णांक
|
0-25 |
| ecc |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
परवानगी असलेली मूल्ये: L, M, Q, H |
| text |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = text |
| url |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = url |
| phone |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = phone |
| sms |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = sms |
|
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = email | |
|
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = whatsapp | |
| facetime |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = facetime |
| event |
पर्यायी
ui.admin.api_docs.common.types.स्ट्रिंग
|
उपलब्ध जेव्हा: type = event |
| location |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| wifi |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| crypto |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| vcard |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| paypal |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| upi |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| epc |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| pix |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| coupon |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
| google_review |
पर्यायी
ui.admin.api_docs.common.types.ऑब्जेक्ट
|
वर्णन नाही |
प्रतिसाद उदाहरण
{
"data": {
"id": 1
}
}
एंडपॉइंट
DELETE https://rqrcode.com/api/qr-codes/{qr_code_id}
उदाहरण
curl --request DELETE \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
परिमाणे
अतिरिक्त parameter नाही.
प्रतिसाद उदाहरण
यशस्वी झाल्यावर रिकामा 200 response body.