תיעוד 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 ריק בעת הצלחה.