API प्रमाणीकरण

हर API अनुरोध को डेवलपर डैशबोर्ड में बनाई गई API key से प्रमाणित करना आवश्यक है।

Keys कैसे काम करती हैं

• Keys का फ़ॉर्मेट qrc_ और उसके बाद 64 हेक्साडेसिमल वर्ण होता है।
• पूरी key केवल एक बार, बनाते समय दिखाई जाती है। हम केवल SHA-256 हैश संग्रहीत करते हैं, इसलिए इसे बाद में कभी पुनर्प्राप्त नहीं किया जा सकता — यदि आप इसे खो दें, तो उसे रद्द करें और नई बनाएं।
• आप कई keys बना सकते हैं (उदाहरण के लिए, हर एनवायरनमेंट के लिए एक) और किसी भी key को स्वतंत्र रूप से रद्द कर सकते हैं।
• Keys केवल डैशबोर्ड में ही बनाई और रद्द की जाती हैं; key प्रबंधन के लिए कोई API एंडपॉइंट नहीं है।

Key भेजना

Bearer स्कीम के साथ Authorization हेडर का उपयोग करें:

POST /api/v1/qr HTTP/1.1
Host: www.qrcodegenius.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

एकमात्र अपवाद GET /render है, जो key को ?key= क्वेरी पैरामीटर के रूप में स्वीकार करता है ताकि इसे सीधे इमेज सोर्स के रूप में उपयोग किया जा सके।

Keys को सुरक्षित रखना

• Keys को एनवायरनमेंट वेरिएबल्स (उदाहरण के लिए .env फ़ाइल) में रखें, कभी भी सोर्स कोड या सार्वजनिक रिपॉज़िटरी में नहीं।
• API को अपने बैकएंड से कॉल करें, ब्राउज़र या मोबाइल ऐप से नहीं।
• यदि कोई key लीक हो जाए, तो उसे तुरंत डेवलपर डैशबोर्ड में रद्द करें — रद्दीकरण तुरंत प्रभावी होता है।

प्रमाणीकरण त्रुटियाँ

• 401 Unauthorized — Authorization हेडर गायब है या गलत फ़ॉर्मेट में है, या key अमान्य है या रद्द की जा चुकी है।
• 403 Forbidden — key मान्य है लेकिन आपके प्लान में यह सुविधा शामिल नहीं है (उदाहरण के लिए, बल्क जनरेशन के लिए Pro आवश्यक है)।
• 429 Too Many Requests — आपका मासिक कोटा और क्रेडिट समाप्त हो चुके हैं। देखें त्रुटियाँ और रेट लिमिट।