مستندات API
کدهای QR
لیست، بازرسی، ایجاد، بهروزرسانی و حذف کدهای QR خود را انجام دهید.
احراز هویت
هر درخواست باید هدر Authorization را با توکن Bearer مطابق با کلید API مدیریت ارسال کند.
دریافت کلید 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}'
پارامترها
پارامتر اضافی ندارد.
نمونه پاسخ
{
"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}'
پارامترها
پارامتر اضافی ندارد.
نمونه پاسخ
بدنه پاسخ 200 در حالت موفقیت خالی است.