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 ہو تو text کی ہر سطر کے لیے ایک QR بنتا ہے۔
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
}'

Wi-Fi QR

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 ہو تو text کی ہر سطر کے لیے ایک QR بنتا ہے۔
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 کو اپنی کلید سے بدلیں۔