सभी API अनुरोधों के लिए API कुंजी का उपयोग करके प्रमाणीकरण की आवश्यकता होती है। यह गाइड API कुंजी को सुरक्षित रूप से बनाने, प्रबंधित करने और उपयोग करने के तरीके को समझाती है।
API कुंजी प्राप्त करने के लिए, आपके पास एक iloveQR खाता होना चाहिए और एक संगठन का हिस्सा होना चाहिए।
यदि आपके पास खाता नहीं है तो साइन इन करें या खाता बनाएं।
अपने API कुंजी प्रबंधित करने के लिए डैशबोर्ड → डेवलपर्स पर जाएं।
'API Key बनाएं' पर क्लिक करें, इसे एक वर्णनात्मक नाम दें, और उत्पन्न कुंजी को सुरक्षित रूप से स्टोर करें।
हर अनुरोध के साथ X-API-Key हेडर में अपना API कुंजी शामिल करें:
curl -X GET \
https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
-H "X-API-Key: ilqr_your_api_key_here" \
-H "Content-Type: application/json"अधिकांश API एंडपॉइंट्स को URL पथ में एक संगठन ID की आवश्यकता होती है। आप अपने संगठन ID को डैशबोर्ड सेटिंग्स में या संगठनों के एंडपॉइंट पर अनुरोध करके पा सकते हैं।
curl -X GET \
https://api.iloveqr.com/api/v1/users/me/organizations \
-H "X-API-Key: ilqr_your_api_key_here"{
"organizations": [
{
"id": "org_abc123",
"name": "My Company",
"slug": "my-company",
"role": "ADMIN"
}
]
}हमेशा अपने सर्वर से API कॉल करें। कभी भी ब्राउज़र, मोबाइल ऐप, या किसी भी कोड में जो उपयोगकर्ताओं द्वारा देखा जा सकता है, API कुंजी शामिल न करें।
अपने API कुंजी को पर्यावरण चर में स्टोर करें, अपने कोडबेस में नहीं। इससे संस्करण नियंत्रण के माध्यम से आकस्मिक उजागर होने से रोका जा सकता है।
नियमित रूप से नए API कुंजी बनाएं और पुराने को रद्द करें। यदि आपको संदेह है कि कोई कुंजी समझौता की गई है, तो इसे तुरंत रद्द करें।
जब प्रमाणीकरण विफल होता है, तो API इनमें से एक त्रुटि प्रतिक्रिया लौटाता है:
| स्थिति कोड | त्रुटि | विवरण |
|---|---|---|
401 | UNAUTHORIZED | गुम या अमान्य API कुंजी |
403 | FORBIDDEN | API कुंजी को इस क्रिया के लिए अनुमति नहीं है |
403 | API_KEY_REVOKED | API कुंजी को रद्द कर दिया गया है |
{
"statusCode": 401,
"message": "Invalid or missing API key",
"error": "Unauthorized"
}अब जब आप प्रमाणीकरण को समझते हैं, तो जानें कि API का उपयोग कैसे करें: