डेवलपर QR कोड एपीआई गाइड

QR कोड एपीआई उपयोगकर्ताओं को उच्च गुणवत्ता वाले QR कोड बनाने या उच्च मात्रा में तेज़ QR कोड जनरेशन को प्रोग्रामेटिक रूप से एकीकृत करने की अनुमति देता है। यह विभिन्न उपयोग मामलों के लिए QR कोड बनाने का एक सरल और प्रभावी तरीका प्रदान करता है, जैसे स्वचालित भुगतान, ऐप्स में एकीकरण, उत्पाद लेबल निर्माण, और बहुत कुछ। एपीआई विभिन्न अनुकूलन विकल्पों का समर्थन करता है, जैसे आकार, रंग, आकार, सीमा, प्रकार, आदि। डेवलपर्स इसे HTTP अनुरोध करके और प्रमाणीकरण के लिए एपीआई कुंजी प्रदान करके अपनी एप्लिकेशनों में एकीकृत कर सकते हैं, या हमारे पुस्तकालयों का उपयोग कर सकते हैं।

एपीआई कुंजी

आपके खाते के लिए API कुंजी को खाता पृष्ठ पर बनाया जा सकता है। API कुंजी को अनुरोधों में या तो एक URL पैरामीटर के रूप में शामिल किया जा सकता है, उदाहरण के लिए: https://api.genqrcode.com/public/generate?apikey=YOUR_API_KEY, या `GenQRCode-apikey` हेडर में। इस गाइड के बाकी हिस्से के लिए, हम हेडर के उपयोग को मान लेंगे, क्योंकि यह अधिक सुरक्षित विकल्प है, लेकिन दोनों तरीकों का परस्पर उपयोग किया जा सकता है। API कुंजी को एक गुप्त जानकारी माना जाना चाहिए, और आपको इसे किसी के साथ साझा नहीं करना चाहिए।

दर सीमा

दर सीमा यह सुनिश्चित करने के लिए लागू की जाती है कि एपीआई का निष्पक्ष उपयोग किया जा सके। मुफ्त स्तर में प्रति घंटे 180 टोकन शामिल हैं। सामान्य QR कोड प्रत्येक के लिए 1 टोकन खर्च करते हैं, जिसमें प्रति घंटे 180 टोकन की अधिकतम सीमा होती है, जो प्रति 20 सेकंड में 1 QR कोड के बराबर है। इसके अतिरिक्त, तेज़ कॉल एंडपॉइंट्स 1/50वें टोकन की लागत पर होते हैं, जो प्रति सेकंड 2.5 QR कोड के बराबर होते हैं। जब कस्टमाइज़ेशन की आवश्यकता नहीं होती है, तो इन तेज़ एंडपॉइंट्स का उपयोग करने की सिफारिश की जाती है। यदि टोकन सीमा का उल्लंघन किया जाता है, तो एक स्थिति कोड 429 लौटाया जाएगा, जो यह सूचित करेगा कि अनुरोध को दर सीमा के तहत रखा गया है।

इन सीमाओं को पार करने के लिए कई खातों का उपयोग करना मना है। यदि उच्च सीमाओं की आवश्यकता है, तो कृपया कीमत के लिए हमसे संपर्क करें।

पुस्तकालय

Java Library

स्थिर QR कोड एपीआई

QR कोड प्रकार

QR कोड प्रकार हर QR कोड का आधार है। यह निर्धारित करता है कि डेटा को कैसे कोडित किया गया है और स्कैन करने पर QR कोड कैसे व्यवहार करेगा। सही प्रकार का चयन करना महत्वपूर्ण है, क्योंकि यह आपके QR कोड की कार्यक्षमता को प्रभावित करता है। नीचे, आपको सभी उपलब्ध प्रकार मिलेंगे जिन्हें आप चुन सकते हैं।

Text

पैरामीटर प्रकार वैकल्पिक विवरण
type Int false Use 0 For a Text QR Code
text String false QR कोड के भीतर टेक्स्ट।

WiFi

पैरामीटर प्रकार वैकल्पिक विवरण
type Int false Use 1 For a WiFi QR Code
network String false वाई-फ़ाई नेटवर्क का नाम।
password String true वाई-फ़ाई पासवर्ड।
hidden String true क्या वाई-फ़ाई नेटवर्क छिपा हुआ है।
encryption String true वाई-फ़ाई नेटवर्क के लिए एन्क्रिप्शन प्रकार।

संभव मान

wep यदि वाई-फ़ाई नेटवर्क अभी भी पुरानी WEP एन्क्रिप्शन का उपयोग करता है, तो इसका उपयोग करें।
nopass यदि वाई-फ़ाई नेटवर्क में कोई पासवर्ड नहीं है, तो इसका उपयोग करें।
wpa डिफ़ॉल्ट मान। WPA एन्क्रिप्शन के लिए इसका उपयोग करें। यदि आप सुनिश्चित नहीं हैं कि कौन सा उपयोग करना है, तो इसका उपयोग करें।

SMS

पैरामीटर प्रकार वैकल्पिक विवरण
type Int false Use 2 For a SMS QR Code
text String false टेक्स्ट संदेश।
number String false फ़ोन नंबर।

Email

पैरामीटर प्रकार वैकल्पिक विवरण
type Int false Use 3 For a Email QR Code
email String true "To" फ़ील्ड में ईमेल पता।
email-cc String true "cc" फ़ील्ड में ईमेल पता.
email-bcc String true "Bcc" फ़ील्ड में ईमेल पता.
subject String true ईमेल का विषय।
message String true ईमेल का संदेश।

Phone

पैरामीटर प्रकार वैकल्पिक विवरण
type Int false Use 4 For a Phone QR Code
number String false फ़ोन नंबर।

Crypto

पैरामीटर प्रकार वैकल्पिक विवरण
type Int false Use 5 For a Crypto QR Code
cryptotype String false भेजने के लिए क्रिप्टो प्रकार।
address String false प्राप्तकर्ता का क्रिप्टो पता।
amount String true भेजने के लिए क्रिप्टो राशि।

vCard

पैरामीटर प्रकार वैकल्पिक विवरण
type Int false Use 6 For a vCard QR Code
vc_first_name String false vCard का पहला नाम।
vc_last_name String false vCard का अंतिम नाम।
vc_company String true कंपनी का नाम।
vc_job String true नौकरी का शीर्षक।
vc_street String true सड़क का नाम।
vc_city String true शहर का नाम।
vc_state String true राज्य का नाम।
vc_zip String true ज़िप कोड।
vc_country String true देश का नाम।
vc_phone String true फ़ोन नंबर।
vc_mobile String true मोबाइल फ़ोन नंबर।
vc_fax String true फ़ैक्स नंबर।
vc_website String true वेबसाइट URL।
vc_email String true ईमेल पता।
vc_note String true एक नोट।

Whatsapp

पैरामीटर प्रकार वैकल्पिक विवरण
type Int false Use 7 For a Whatsapp QR Code
number String false फ़ोन नंबर।
text String true व्हाट्सएप टेक्स्ट संदेश।

vEvent

पैरामीटर प्रकार वैकल्पिक विवरण
type Int false Use 8 For a vEvent QR Code
ve_summary String true vEvent का सारांश।
ve_description String true vEvent का विवरण।
ve_location String true vEvent का स्थान।
ve_timezone String true vEvent की प्रारंभ और समाप्ति समय की समय क्षेत्र। उदाहरण के लिए, एम्स्टर्डम समय क्षेत्र के लिए "Europe/Amsterdam" का उपयोग करें।
ve_url String true vEvent का URL।
ve_start String true vEvent का प्रारंभ समय। उदाहरण के लिए, 1 जनवरी 2025 को सुबह 8:30 के लिए "20250101T083000" का उपयोग करें।
ve_end String true vEvent का समाप्ति समय। उदाहरण के लिए, 1 जनवरी 2025 को सुबह 9:30 के लिए "20250101T093000" का उपयोग करें।

Geo

पैरामीटर प्रकार वैकल्पिक विवरण
type Int false Use 9 For a Geo QR Code
ge_latitude String false एन्कोड करने के लिए अक्षांश।
ge_longitude String false एन्कोड करने के लिए देशांतर।

उदाहरण टेक्स्ट QR कोड

URL https://api.genqrcode.com/public/generate
अनुरोध विधि POST
हेडर GenQRCode-apikey: API_KEY
शरीर 
{
  "type": 0,
  "text": "https://genqrcode.com"
}
प्रतिक्रिया Text QR Code example

उदाहरण Wi-Fi QR कोड

URL https://api.genqrcode.com/public/generate
अनुरोध विधि POST
हेडर GenQRCode-apikey: API_KEY
शरीर 
{
  "type": 1,
  "network": "GenQRCode",
  "password": false,
  "hidden": false,
  "encryption": "wpa"
}
प्रतिक्रिया WiFi QR Code example

सामान्य पैरामीटर

यहां सभी कस्टमाइज़ेबल सामान्य पैरामीटर दिए गए हैं जिन्हें उपयोग करने का तरीका बताया गया है।

पैरामीटर प्रकार डिफ़ॉल्ट मान विवरण
imageformat String png QR कोड की छवि प्रारूप।

संभव मान

tiff TIFF छवि प्रारूप।
svg SVG छवि प्रारूप।
gif GIF छवि प्रारूप।
obj OBJ छवि प्रारूप। पूर्ण रंग समर्थन।
png PNG छवि प्रारूप।
jpeg JPEG छवि प्रारूप। पारदर्शिता का समर्थन नहीं करता है।
eps EPS छवि प्रारूप।
stl STL छवि प्रारूप। रंग का समर्थन नहीं करता है।
webp WEBP छवि प्रारूप।
3mf 3MF छवि प्रारूप।
bordersize Int 4 QR कोड के चारों ओर सीमा आकार।
width Int 500 QR कोड की चौड़ाई। अधिकतम आकार 2000।
height Int 500 QR कोड की ऊँचाई। अधिकतम आकार 2000।

रंग पैरामीटर

यहां सभी कस्टमाइज़ेबल रंग पैरामीटर दिए गए हैं जिन्हें उपयोग करने का तरीका बताया गया है।

पैरामीटर प्रकार डिफ़ॉल्ट मान विवरण
color String #000000 QR कोड का रंग। प्रारूप होना चाहिए या तो #RRGGBB या #RRGGBBAA। RGBA मान हेक्साडेसिमल प्रारूप में होते हैं, जो 00 से FF तक होते हैं।
custom_color_pattern String 1 उपयोग करने के लिए रंगों का पैटर्न। उदाहरण के लिए, यदि रंग #ff0000, #00ff00, और #0000ff हैं, और पैटर्न 1,2,3,3,2,1 है, तो रंग उस पैटर्न के अनुसार वैकल्पिक होंगे। एक उदाहरण बाद में मार्गदर्शिका में प्रदान किया जाएगा।
background_color String #FFFFFF QR कोड की पृष्ठभूमि का रंग। यदि आप QR कोड की पृष्ठभूमि को पारदर्शी बनाना चाहते हैं, तो अल्फा चैनल को 00 पर सेट करें। उदाहरण के लिए, #00000000।
inner_eye_color String #000000 QR कोड की आंतरिक आंखों का रंग।
outer_eye_color String #000000 QR कोड की बाहरी आंखों का रंग।
frame_color String #000000 QR कोड के चारों ओर फ्रेम का रंग। एक फ्रेम के लिए टेक्स्ट सक्षम करने के लिए इसे कॉन्फ़िगर करना आवश्यक है।
frame_background_color String #FFFFFF फ्रेम की पृष्ठभूमि का रंग। प्रभाव के लिए फ्रेम सक्षम होना चाहिए।
frame_text_color String #FFFFFF फ्रेम के टेक्स्ट का रंग। प्रभाव के लिए टेक्स्ट वाला फ्रेम सक्षम होना चाहिए।

उदाहरण रंग QR कोड

URL https://api.genqrcode.com/public/generate
अनुरोध विधि POST
हेडर GenQRCode-apikey: API_KEY
शरीर 
{
  "type": 0,
  "text": "https://genqrcode.com",
  "color": "#ff0000",
  "background_color": "#aaffaa",
  "inner_eye_color": "#ffaaaa",
  "outer_eye_color": "#ffaaff"
}
प्रतिक्रिया Color QR Code example

उदाहरण रंग पैटर्न QR कोड

URL https://api.genqrcode.com/public/generate
अनुरोध विधि POST
हेडर GenQRCode-apikey: API_KEY
शरीर 
{
  "type": 0,
  "text": "https://genqrcode.com",
  "color": "#e81416,#faeb36,#79c314,#487de7,#4b369d,#70369d",
  "custom_color_pattern": "1,1,2,2,3,3,4,4,5,5,6,6"
}
प्रतिक्रिया Color pattern QR Code example

फ्रेम, आकार और लोगो पैरामीटर

यहां सभी कस्टमाइज़ेबल फ्रेम, आकार और लोगो पैरामीटर दिए गए हैं जिन्हें उपयोग करने का तरीका बताया गया है।

पैरामीटर प्रकार डिफ़ॉल्ट मान विवरण
style Int 0 QR कोड वर्गों की शैली।
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
inner_eye_style Int 0 QR कोड की आंतरिक आंखों की शैली।
0
1
2
3
4
5
6
7
outer_eye_style Int 0 QR कोड की बाहरी आंखों की शैली।
0
1
2
3
4
5
6
frame_style Int 0 QR कोड के फ्रेम की शैली।
0
1
SCAN ME
2
SCAN ME
3
SCAN ME
4
SCAN ME
5
SCAN ME
6
SCAN ME
7
8
9
10
SCAN ME
11
SCAN ME
12
SCAN ME
13
SCAN ME
14
15
frame_text String SCAN ME फ्रेम के भीतर टेक्स्ट। एक फ्रेम के साथ टेक्स्ट देखने के लिए पहले इसे कॉन्फ़िगर करना आवश्यक है।
logo String QR कोड के भीतर उपयोग करने के लिए लोगो।
youtube
wifi
google-maps
facebook
spotify
threads
zoom
instagram
linkedin
genqrcode
google-drive
airbnb
skype
snapchat
twitter
x-twitter
reddit
logo_remove_background Boolean false क्या लोगो के पीछे की पृष्ठभूमि को हटाना चाहिए।

उदाहरण लोगो और आकार QR कोड

URL https://api.genqrcode.com/public/generate
अनुरोध विधि POST
हेडर GenQRCode-apikey: API_KEY
शरीर 
{
  "type": 0,
  "text": "https://x.com/genqrcode",
  "style": 22,
  "inner_eye_style": 1,
  "outer_eye_style": 4,
  "frame": 10,
  "frame_text": "My X Page",
  "logo": "x-twitter",
  "logo_remove_background":true
}
प्रतिक्रिया Style and logo QR Code example

उदाहरण कस्टम लोगो

कस्टम लोगो का उपयोग करने के लिए, हमें हमारा लोगो मल्टीपार्ट फॉर्म डेटा अनुरोध का उपयोग करके अपलोड करना होगा। परिणामस्वरूप इसे लोगो फ़ील्ड में उपयोग किया जा सकता है।

URL https://api.genqrcode.com/public/upload/logo
अनुरोध विधि POST
हेडर GenQRCode-apikey: API_KEY
Content-Type: multipart/form-data
प्रतिक्रिया 586d0136af8a06e4a2b50cf9f2af0b72

तेज QR कोड एपीआई

तेज QR कोड एपीआई केवल सामान्य एपीआई के 1/50 टोकन की लागत पर है। QR कोड गति और डाउनलोड आकार के लिए अनुकूलित होते हैं। जबकि यह सभी QR कोड प्रकारों का समर्थन करता है, यह केवल कुछ कस्टमाइज़ेशन पैरामीटर का समर्थन करता है।

तेज़ QR कोड पैरामीटर

यहां सभी तेज़ QR कोड पैरामीटर दिए गए हैं जिन्हें उपयोग करने का तरीका बताया गया है।

पैरामीटर प्रकार डिफ़ॉल्ट मान विवरण
imageformat String png QR कोड की छवि प्रारूप।

संभव मान

svg SVG छवि प्रारूप।
png PNG छवि प्रारूप।
bordersize Int 4 QR कोड के चारों ओर सीमा आकार।
width Int 500 QR कोड की चौड़ाई। यह स्वचालित रूप से निकटतम कॉन्फ़िगर किए गए आकार में समायोजित होगा ताकि किसी भी रिसाइजिंग दोष से बचा जा सके। अधिकतम आकार 4000।
height Int 500 QR कोड की ऊँचाई। यह स्वचालित रूप से निकटतम कॉन्फ़िगर किए गए आकार में समायोजित होगा ताकि किसी भी रिसाइजिंग दोष से बचा जा सके। अधिकतम आकार 4000।

उदाहरण तेज़ टेक्स्ट QR कोड

URL https://api.genqrcode.com/public/fastgenerate
अनुरोध विधि POST
हेडर GenQRCode-apikey: API_KEY
शरीर 
{
  "imageformat": "png",
  "type": 0,
  "text": "https://genqrcode.com"
}
प्रतिक्रिया Text QR Code example

तेज बैच QR कोड एपीआई

उदाहरण तेज़ बैच टेक्स्ट QR कोड

URL https://api.genqrcode.com/public/fastbatch
अनुरोध विधि POST
हेडर GenQRCode-apikey: API_KEY
शरीर 
{
  "QR Code 1": {
    "text": "https://genqrcode.com",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 2": {
    "text": "https://genqrcode.com/dynamicview",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 3": {
    "text": "https://genqrcode.com/pricing",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  }
}
प्रतिक्रिया QR Codes in a zip file.