प्रमाणीकरण

badges.ninja के सभी API अनुरोधों के लिए प्रमाणीकरण की आवश्यकता होती है। यह पृष्ठ समझाता है कि अपने अनुरोधों को कैसे प्रमाणित करें।

बेस URL

https://api.badges.ninja

सभी API एंडपॉइंट इस बेस URL के सापेक्ष हैं।

API कुंजी प्रमाणीकरण

प्राथमिक प्रमाणीकरण विधि X-Api-Key हेडर में पास की गई एक API कुंजी है।

एक API कुंजी प्राप्त करना

डैशबोर्ड से:

1. badges.ninja पर साइन-इन करें।
2. साइडबार में API Keys पर जाएँ।
3. Create API Key पर क्लिक करें।
4. कुंजी कॉपी करें (यह केवल एक बार दिखाई जाती है)।

API से:

API कुंजियों को Cognito प्रमाणीकरण प्रवाह से अपने JWT टोकन का उपयोग करके API के माध्यम से भी प्रबंधित किया जा सकता है। सबसे सरल दृष्टिकोण के लिए डैशबोर्ड देखें।

अपनी API कुंजी का उपयोग

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

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

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

कुंजियाँ bws_ उपसर्ग का उपयोग करती हैं:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

अनुरोध प्रारूप

• GET अनुरोध क्वेरी स्ट्रिंग के रूप में पैरामीटर पास करते हैं
• POST और PUT अनुरोध parameters ऑब्जेक्ट के साथ एक JSON बॉडी भेजते हैं
• सभी प्रतिक्रियाएँ Content-Type: application/json के साथ JSON लौटाती हैं

POST/PUT अनुरोध संरचना

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

उदाहरण अनुरोध

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

उदाहरण प्रतिक्रिया

{
  "statusCode": 200,
  "info": {
    "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
  }
}

दर सीमाएँ

API अनुरोध दर सीमा के अधीन हैं। यदि आप सीमा से अधिक हो जाते हैं, तो आपको 429 Too Many Requests प्रतिक्रिया मिलेगी। कुछ सेकंड प्रतीक्षा करें और पुनः प्रयास करें।

सार्वजनिक एंडपॉइंट

कुछ एंडपॉइंट को प्रमाणीकरण की आवश्यकता नहीं होती। ये /certify-badge/ के तहत सार्वजनिक सत्यापन एंडपॉइंट हैं जो किसी को भी बैज क्रेडेंशियल सत्यापित करने देते हैं।