API कुंजियाँ

API कुंजियाँ आपको badges.ninja REST API को प्रोग्रामेटिक रूप से एक्सेस करने देती हैं। इनका उपयोग अपने एप्लिकेशन से बैज बनाने, जारी करने और प्रबंधित करने को स्वचालित करने के लिए करें।

API कुंजी बनाना

1. साइडबार से API Keys पेज खोलें।
2. Create API Key पर क्लिक करें। एक इनलाइन फ़ॉर्म खुलता है:

3. कुंजी को एक नाम दें और Create पर क्लिक करें। पूरी कुंजी हरे बैनर पर केवल एक बार दिखाई जाती है:

4. कुंजी को तुरंत कॉपी करें — पूरी कुंजी केवल एक बार दिखाई जाती है। यदि आप इसे खो देते हैं, तो आपको नई कुंजी बनानी होगी। बैनर बंद करने के बाद, डैशबोर्ड केवल कुंजी का प्रीफ़िक्स दिखाता है (उदा. bws_a1b2c3d4...); पूरी कुंजी आपके अनुरोधों को प्रमाणित करने के लिए सर्वर-साइड संग्रहीत रहती है:

प्रत्येक पंक्ति में कुंजी बनाए जाने का समय भी दिखता है, और उपयोग होने के बाद एक last used टाइमस्टैंप भी, ताकि आप पुरानी कुंजियों को पहचान सकें।

एक्सेस स्कोप

कुंजी बनाते समय आप उसे केवल-पढ़ने योग्य (read-only) बना सकते हैं या पूर्ण एक्सेस वाली रख सकते हैं:

स्कोप	अनुमति
पूर्ण एक्सेस (डिफ़ॉल्ट)	पढ़ना और लिखना — डेटा सूचीबद्ध करना तथा बनाना, जारी करना, अपडेट करना या हटाना।
केवल-पढ़ने योग्य	केवल सुरक्षित GET अनुरोध। कोई भी बदलाव करने वाला अनुरोध (POST, PUT, PATCH, DELETE) 403 Forbidden के साथ अस्वीकार कर दिया जाता है।

उन इंटीग्रेशन के लिए केवल-पढ़ने योग्य कुंजी का उपयोग करें जिन्हें सिर्फ़ आपका डेटा पढ़ना है (रिपोर्टिंग, डैशबोर्ड, बैकअप), ताकि लीक हुई कुंजी कुछ भी न बदल सके। बनाने के फ़ॉर्म में Read-only key पर टिक करें; केवल-पढ़ने योग्य कुंजियाँ सूची में Read-only बैज के साथ दिखती हैं। स्कोप आने से पहले बनाई गई कुंजियों का पूर्ण एक्सेस बना रहता है।

कुंजी का प्रारूप

API कुंजियाँ bws_ प्रीफ़िक्स और उसके बाद 32 अक्षरों की हेक्स स्ट्रिंग का उपयोग करती हैं:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

अनुरोधों में API कुंजियों का उपयोग

प्रत्येक API अनुरोध के X-Api-Key हेडर में API कुंजी शामिल करें:

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

API प्रमाणीकरण के पूर्ण विवरण के लिए प्रमाणीकरण पेज देखें।

प्लान के अनुसार कुंजी सीमा

आप कितनी API कुंजियाँ बना सकते हैं, यह आपके प्लान पर निर्भर करता है:

प्लान	API कुंजी सीमा
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

कुंजी की समाप्ति

प्रत्येक API कुंजी बनाए जाने के एक वर्ष बाद समाप्त हो जाती है। समाप्त होने पर कुंजी अनुरोधों को प्रमाणित करना बंद कर देती है, ठीक वैसे ही जैसे उसे हटा दिया गया हो। व्यवधान से बचने के लिए पुरानी कुंजी समाप्त होने से पहले नई कुंजी बना लें।

कुंजी हटाना

1. API Keys पेज खोलें।
2. वह कुंजी ढूँढें जिसे आप हटाना चाहते हैं।
3. Delete पर क्लिक करें।
4. हटाने की पुष्टि करें।

हटाने के बाद कुंजी तुरंत काम करना बंद कर देती है। उस कुंजी का उपयोग करने वाले किसी भी एप्लिकेशन को प्रमाणीकरण त्रुटियाँ मिलेंगी।