প্রমাণীকরণ

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 থেকে:

Cognito প্রমাণীকরণ প্রবাহ থেকে পাওয়া আপনার JWT টোকেন ব্যবহার করে API-এর মাধ্যমেও 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"
    }
  }'

প্রতিক্রিয়ার উদাহরণ

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

পাবলিক এন্ডপয়েন্ট

কিছু এন্ডপয়েন্টে প্রমাণীকরণ প্রয়োজন হয় না। এগুলো হলো /certify-badge/-এর অধীনে পাবলিক যাচাই এন্ডপয়েন্ট, যা যে কাউকে ব্যাজ ক্রেডেনশিয়াল যাচাই করতে দেয়।