प्रमाणीकरण

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

बेस URL

https://api.badges.ninja

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

API Key प्रमाणीकरण

प्रमाणीकरण की मुख्य विधि X-Api-Key हेडर में भेजी गई API key है।

API Key प्राप्त करना

डैशबोर्ड से:

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

API से:

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

अपनी API Key का उपयोग करना

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

bash

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

API Key का फ़ॉर्मैट

Keys में bws_ उपसर्ग होता है:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

अनुरोध का फ़ॉर्मैट

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

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

json

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

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

bash

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"
    }
  }'

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

json

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

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

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

प्रमाणीकरण ​

बेस URL ​

API Key प्रमाणीकरण ​

API Key प्राप्त करना ​

अपनी API Key का उपयोग करना ​

API Key का फ़ॉर्मैट ​

अनुरोध का फ़ॉर्मैट ​

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

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

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

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