رموز QR

أنشئ رموز QR بشعار وألوان وأنماط وأنواع محتوى، ثم اعرضها أو حدّثها.

الأنواع المدعومة

مرّر type كأحد هذه المفاتيح. حقول المحتوى تتغير حسب النوع.

text
url
phone
sms
email
whatsapp
facetime
location
wifi
event
vcard
crypto
paypal
upi
epc
pix

POST/api/v1/qr-codes

إنشاء رمز QR

أرسل JSON في متن الطلب. name و type مطلوبان. لأنواع url، مرّر url. أضف style والألوان و qr_code_logo لمطابقة رمز مصمَّم من الاستوديو. نوع file غير متاح عبر API.

الاسم	النوع	مطلوب	الافتراضي	الوصف
name	string	نعم	—	التسمية المحفوظة على المورد.
type	string	نعم	url	نوع المحتوى. أحد مفاتيح QR المدعومة، باستثناء file.
url	string	لا	—	عنوان URL الوجهة. مطلوب عندما يكون type هو url.
text	string	لا	—	نص عادي. مطلوب عندما يكون type هو text. للنص الجماعي، افصل الأسطر في هذا الحقل.
url_dynamic	boolean	لا	false	إذا كان true، يُنشأ رابط قصير ويشفّر رمز QR ذلك الرابط حتى يمكن تغيير الوجهة لاحقًا.
project_id	integer	لا	—	المشروع لإرفاق المورد به.
is_bulk	boolean	لا	false	إذا كان true وكان type هو text، يُنشأ رمز QR واحد لكل سطر في text.
style	string	لا	square	شكل الوحدة. أمثلة: square، dot، rounded، heart، hexagon.
inner_eye_style	string	لا	square	شكل نمط الباحث الداخلي. أمثلة: square، dot، circle، rounded.
outer_eye_style	string	لا	square	شكل نمط الباحث الخارجي. أمثلة: square، circle، rounded، flower.
size	integer	لا	500	حجم الصورة بالبكسل، 50–2000.
margin	integer	لا	0	وحدات المنطقة الهادئة، 0–25.
ecc	string	لا	M	تصحيح الأخطاء: L أو M أو Q أو H. استخدم H عند إضافة شعار.
foreground_type	string	لا	color	color أو gradient.
foreground_color	string	لا	#000000	لون الوحدات بصيغة HEX.
foreground_gradient_style	string	لا	horizontal	vertical أو horizontal أو diagonal أو inverse_diagonal أو radial.
foreground_gradient_one	string	لا	—	لون التدرج الأول بصيغة HEX.
foreground_gradient_two	string	لا	—	لون التدرج الثاني بصيغة HEX.
background_color	string	لا	#ffffff	لون الخلفية بصيغة HEX. اجعله أفتح من الوحدات.
background_color_transparency	integer	لا	0	شفافية الخلفية، 0–100.
custom_eyes_color	boolean	لا	false	إذا كان true، تستخدم العيون eyes_inner_color و eyes_outer_color.
eyes_inner_color	string	لا	#000000	لون العين الداخلية بصيغة HEX.
eyes_outer_color	string	لا	#000000	لون العين الخارجية بصيغة HEX.
qr_code_logo	string	لا	—	عنوان URL لصورة الشعار أو مفتاح الملف المرفوع.
qr_code_logo_size	number	لا	25	حجم الشعار كنسبة من رمز QR، 5–40.
frame	string	لا	—	مفتاح إطار اختياري من الاستوديو.
frame_text	string	لا	—	التعليق المرسوم على الإطار.

حقول المحتوى حسب النوع

الاسم	النوع	مطلوب	الافتراضي	الوصف
phone	string	لا	—	رقم الهاتف عندما يكون type هو phone.
sms	string	لا	—	رقم الهاتف عندما يكون type هو sms.
sms_body	string	لا	—	نص رسالة SMS.
email	string	لا	—	المستلم عندما يكون type هو email.
email_subject	string	لا	—	موضوع البريد.
email_body	string	لا	—	نص البريد.
whatsapp	string	لا	—	رقم WhatsApp، أرقام فقط.
whatsapp_body	string	لا	—	نص WhatsApp المعبأ مسبقًا.
wifi_ssid	string	لا	—	اسم الشبكة عندما يكون type هو wifi.
wifi_password	string	لا	—	كلمة مرور Wi-Fi.
wifi_encryption	string	لا	WPA	nopass أو WEP أو WPA أو WPA/WPA2.
location_latitude	number	لا	—	خط العرض عندما يكون type هو location.
location_longitude	number	لا	—	خط الطول عندما يكون type هو location.
event	string	لا	—	عنوان الحدث عندما يكون type هو event.
event_start_datetime	string	لا	—	تاريخ ووقت ISO لبداية الحدث.
vcard first_name / last_name / email	string	لا	—	حقول vCard: first_name و last_name و email وبقية مفاتيح الاستوديو.

مثال على الطلب

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}'

المزيد من الأمثلة

رمز QR متدرج

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Gradient QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "dot",
  "inner_eye_style": "circle",
  "outer_eye_style": "rounded",
  "foreground_type": "gradient",
  "foreground_gradient_style": "radial",
  "foreground_gradient_one": "#5c8b29",
  "foreground_gradient_two": "#25492f",
  "background_color": "#ffffff",
  "size": 600
}'

رمز QR لـ Wi-Fi

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Office Wi-Fi",
  "type": "wifi",
  "wifi_ssid": "Guest",
  "wifi_password": "correct-horse",
  "wifi_encryption": "WPA",
  "style": "square",
  "ecc": "H"
}'

مثال على الاستجابة

{
  "data": {
    "id": 1,
    "type": "url",
    "name": "Website QR",
    "qr_code": "https://…/qr-codes/…/qr.svg",
    "settings": {
      "style": "rounded",
      "size": 500,
      "ecc": "M"
    }
  }
}

GET/api/v1/qr-codes

إدراج رمز QR

الاسم	النوع	مطلوب	الوصف
page	integer	لا	Page number (default 1)
results_per_page	integer	لا	Items per page (default 25, max 100)
search	string	لا	Search term
search_by	string	لا	Column to search
order_by	string	لا	Sort column
order_type	string	لا	asc or desc
datetime_start	string	لا	ISO datetime filter start
datetime_end	string	لا	ISO datetime filter end
project_id	integer	لا	—
type	string	لا	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/v1/qr-codes/{id}

قراءة رمز QR واحد

الاسم	النوع	مطلوب	الوصف
id	integer	نعم	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/v1/qr-codes/{id}

تحديث رمز QR

الاسم	النوع	مطلوب	الافتراضي	الوصف
id	integer	نعم	—	—
name	string	لا	—	التسمية المحفوظة على المورد.
type	string	لا	url	نوع المحتوى. أحد مفاتيح QR المدعومة، باستثناء file.
url	string	لا	—	عنوان URL الوجهة. مطلوب عندما يكون type هو url.
text	string	لا	—	نص عادي. مطلوب عندما يكون type هو text. للنص الجماعي، افصل الأسطر في هذا الحقل.
url_dynamic	boolean	لا	false	إذا كان true، يُنشأ رابط قصير ويشفّر رمز QR ذلك الرابط حتى يمكن تغيير الوجهة لاحقًا.
project_id	integer	لا	—	المشروع لإرفاق المورد به.
is_bulk	boolean	لا	false	إذا كان true وكان type هو text، يُنشأ رمز QR واحد لكل سطر في text.
style	string	لا	square	شكل الوحدة. أمثلة: square، dot، rounded، heart، hexagon.
inner_eye_style	string	لا	square	شكل نمط الباحث الداخلي. أمثلة: square، dot، circle، rounded.
outer_eye_style	string	لا	square	شكل نمط الباحث الخارجي. أمثلة: square، circle، rounded، flower.
size	integer	لا	500	حجم الصورة بالبكسل، 50–2000.
margin	integer	لا	0	وحدات المنطقة الهادئة، 0–25.
ecc	string	لا	M	تصحيح الأخطاء: L أو M أو Q أو H. استخدم H عند إضافة شعار.
foreground_type	string	لا	color	color أو gradient.
foreground_color	string	لا	#000000	لون الوحدات بصيغة HEX.
foreground_gradient_style	string	لا	horizontal	vertical أو horizontal أو diagonal أو inverse_diagonal أو radial.
foreground_gradient_one	string	لا	—	لون التدرج الأول بصيغة HEX.
foreground_gradient_two	string	لا	—	لون التدرج الثاني بصيغة HEX.
background_color	string	لا	#ffffff	لون الخلفية بصيغة HEX. اجعله أفتح من الوحدات.
background_color_transparency	integer	لا	0	شفافية الخلفية، 0–100.
custom_eyes_color	boolean	لا	false	إذا كان true، تستخدم العيون eyes_inner_color و eyes_outer_color.
eyes_inner_color	string	لا	#000000	لون العين الداخلية بصيغة HEX.
eyes_outer_color	string	لا	#000000	لون العين الخارجية بصيغة HEX.
qr_code_logo	string	لا	—	عنوان URL لصورة الشعار أو مفتاح الملف المرفوع.
qr_code_logo_size	number	لا	25	حجم الشعار كنسبة من رمز QR، 5–40.
frame	string	لا	—	مفتاح إطار اختياري من الاستوديو.
frame_text	string	لا	—	التعليق المرسوم على الإطار.

مثال على الطلب

curl -X PATCH 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://forqrcode.com/pricing",
  "foreground_color": "#5d2a1a"
}'

DELETE/api/v1/qr-codes/{id}

حذف رمز QR

الاسم	النوع	مطلوب	الوصف
id	integer	نعم	—

curl -X DELETE 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

أسماء المعلمات وأمثلة JSON بالإنجليزية. استبدل YOUR_API_KEY بمفتاح حسابك.