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 को अपनी कुंजी से बदलें।