Issuers API

ব্যাজ ইস্যুকারীদের পরিচালনা করুন — যে সংস্থা বা ব্যক্তিরা ব্যাজ ইস্যু করে।

সব এন্ডপয়েন্টে X-Api-Key হেডারের মাধ্যমে অথেন্টিকেশন প্রয়োজন। দেখুন অথেন্টিকেশন।

ইস্যুকারী তৈরি

একটি নতুন ব্যাজ ইস্যুকারী তৈরি করুন।

POST /issuers

প্যারামিটার

প্যারামিটার	টাইপ	আবশ্যক	বিবরণ
name	string	হ্যাঁ	সংস্থার নাম (সর্বনিম্ন ৩টি অক্ষর)
url	string	হ্যাঁ	সংস্থার ওয়েবসাইট (অবশ্যই বৈধ HTTP/HTTPS URL হতে হবে)
email	string	হ্যাঁ	ইস্যুকারীর যোগাযোগের ইমেইল
logo	string	না	Base64-এনকোডেড ছবি (PNG বা JPG)
linkedinOrganizationId	string	না	LinkedIn কোম্পানি পেজের সংখ্যাসূচক ID। সেট করা থাকলে এই ইস্যুকারীর প্রতিটি পাবলিক credential পেজে একটি Add to LinkedIn Profile বাটন দেখায়।

উদাহরণ

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": "Acme Academy",
      "url": "https://acme.example.com",
      "email": "badges@acme.example.com"
    }
  }'

রেসপন্স

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

নোট

• এটি আপনার প্ল্যানের ইস্যুকারী সীমার মধ্যে গণ্য হয় (Free: ২, Starter: ৫, Pro: ১০)। কোনো কোটা কাটা হয় না।
• ইস্যুকারীর ইমেইল আপনার অ্যাকাউন্টের ইমেইলের সাথে মিললে ইস্যুকারী স্বয়ংক্রিয়ভাবে যাচাই হয়ে যায়।
• ইমেইল ভিন্ন হলে ইস্যুকারীর ইমেইলে একটি যাচাইকরণ ইমেইল পাঠানো হয়।
• ইস্যুকারী কনফিগার করার পর সেই ইস্যুকারীর অধীনে credential ইস্যু শুরু করতে Credentials API ব্যবহার করুন।

---

ইস্যুকারীদের তালিকা

আপনার তৈরি করা সব ইস্যুকারী পান।

GET /issuers

উদাহরণ

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

রেসপন্স

{
  "items": [
    {
      "id": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
      "name": "Acme Academy",
      "url": "https://acme.example.com",
      "email": "badges@acme.example.com",
      "verified": true,
      "timestamp": 1736937000000
    }
  ]
}

timestamp হলো মিলিসেকেন্ডে Unix epoch। এক পেজে ধরার চেয়ে বেশি ইস্যুকারী থাকলে পেজিনেশনের জন্য একটি lastEvaluatedKey-ও ফেরত আসে।

---

ইস্যুকারী যাচাই

ইস্যুকারীর ইমেইলে পাঠানো যাচাইকরণ কোড ব্যবহার করে তাকে যাচাই করুন।

POST /issuers/{issuerId}/verify

প্যারামিটার

প্যারামিটার	টাইপ	আবশ্যক	বিবরণ
issuerId	string	হ্যাঁ	ইস্যুকারীর ID (পাথ প্যারামিটার)
code	string	হ্যাঁ	ইমেইলে পাওয়া যাচাইকরণ কোড

উদাহরণ

curl -X POST https://api.badges.ninja/issuers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/verify \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "code": "ABC123"
    }
  }'

রেসপন্স

একটি সাধারণ স্ট্রিং:

"issuer has been verified"

---

ইস্যুকারী মোছা

একটি ইস্যুকারী মুছুন। ইস্যুকারীর সাথে কোনো ব্যাজ যুক্ত থাকা চলবে না।

DELETE /issuers/{issuerId}

উদাহরণ

curl -X DELETE https://api.badges.ninja/issuers/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "X-Api-Key: bws_your_api_key_here"

রেসপন্স

একটি সাধারণ স্ট্রিং:

"issuer has been deleted"

ত্রুটি

• 400 — ইস্যুকারীর সাথে এখনও ব্যাজ যুক্ত আছে: issuer has {n} badge(s) linked — delete the badges first। মোছা শুধুমাত্র যুক্ত ব্যাজ দ্বারা বাধাগ্রস্ত হয় — credential এতে বাধা দেয় না।
• 404 — ইস্যুকারী পাওয়া যায়নি

---

ইস্যুকারী আপডেট

একটি ইস্যুকারীর ফিল্ড আপডেট করুন। শুধু অযাচাইকৃত ইস্যুকারী সম্পাদনা করা যায় — ইস্যুকারী যাচাই হয়ে গেলে credential-এর স্থিতিশীলতা বজায় রাখতে এই এন্ডপয়েন্ট 400 verified issuers cannot be edited ফেরত দেয়। ইস্যুকারী সম্পাদনা করলে তার যাচাইকরণ কোড নতুন করে তৈরি হয়: email আপনার অ্যাকাউন্টের ইমেইলের সাথে মিললে ইস্যুকারী স্বয়ংক্রিয়ভাবে আবার যাচাই হয়, নইলে ওই ঠিকানায় নতুন যাচাইকরণ ইমেইল পাঠানো হয়।

PUT /issuers/{issuerId}

প্যারামিটার

প্যারামিটার	টাইপ	আবশ্যক	বিবরণ
issuerId	string	হ্যাঁ	ইস্যুকারীর ID (পাথ প্যারামিটার)
name	string	না	নতুন নাম
url	string	না	নতুন URL
email	string	না	নতুন ইমেইল (আপনার অ্যাকাউন্টের ইমেইলের সাথে না মিললে নতুন যাচাইকরণ মেইল পাঠানো হয়)
logo	string	না	নতুন Base64-এনকোডেড লোগো
linkedinOrganizationId	string	না	নতুন LinkedIn অর্গানাইজেশন ID (মুছতে খালি স্ট্রিং দিন)

রেসপন্স

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
  "updated": true
}

ত্রুটি

• 400 — verified issuers cannot be edited (ইস্যুকারী ইতিমধ্যে যাচাইকৃত)
• 400 — not authorized (ইস্যুকারী অন্য অ্যাকাউন্টের)
• 404 — ইস্যুকারী পাওয়া যায়নি