توثيق 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 فارغة عند النجاح.