API कुंजियाँ

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

API कुंजी बनाना

1. साइडबार से API Keys पृष्ठ खोलें।
2. Create API Key पर क्लिक करें। एक इनलाइन फ़ॉर्म खुलेगा:

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

4. कुंजी को तुरंत कॉपी करें — यह केवल एक बार दिखाई जाती है। यदि आप इसे खो देते हैं, तो आपको एक नई बनानी होगी। बैनर बंद करने के बाद, केवल उपसर्ग संग्रहीत रहता है:

एक्सेस स्कोप

जब आप कोई कुंजी बनाते हैं तो आप इसे रीड-ओनली बना सकते हैं या इसे पूर्ण-एक्सेस छोड़ सकते हैं:

स्कोप	अनुमति देता है
पूर्ण एक्सेस (डिफ़ॉल्ट)	पढ़ें और लिखें — डेटा सूचीबद्ध करें और बनाएं, जारी करें, अपडेट करें, या हटाएं।
रीड-ओनली	केवल सुरक्षित 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

एक कुंजी हटाना

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

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