প্রমাণীকরণ

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/ এর অধীনে পাবলিক যাচাইকরণ এন্ডপয়েন্ট যা যেকেউকে ব্যাজ ক্রেডেনশিয়াল যাচাই করতে দেয়।