Skip to content

Issuers API

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

সমস্ত এন্ডপয়েন্টের জন্য X-Api-Key হেডারের মাধ্যমে প্রমাণীকরণ প্রয়োজন। প্রমাণীকরণ দেখুন।

ইস্যুয়ার তৈরি

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

POST /issuers

প্যারামিটার

প্যারামিটারপ্রকারপ্রয়োজনীয়বিবরণ
namestringহ্যাঁসংস্থার নাম (ন্যূনতম 3 অক্ষর)
urlstringহ্যাঁসংস্থার ওয়েবসাইট (বৈধ HTTP/HTTPS URL হতে হবে)
emailstringহ্যাঁইস্যুয়ারের জন্য যোগাযোগ ইমেল
logostringনাBase64-এনকোডেড ছবি (PNG বা JPG)
linkedinOrganizationIdstringনাসংখ্যাসূচক LinkedIn কোম্পানি পৃষ্ঠা ID। সেট করা হলে, এই ইস্যুয়ার থেকে প্রতিটি পাবলিক অ্যাওয়ার্ড পৃষ্ঠায় একটি Add to LinkedIn Profile বোতাম দেখাবে।

উদাহরণ

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

প্রতিক্রিয়া

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

নোট

  • আপনার প্ল্যানের ইস্যুয়ার সীমার বিরুদ্ধে গণ্য হয় (Free: 1, Starter: 5, Pro: সীমাহীন)। কোনো কোটা কর্তন নেই।
  • যদি ইস্যুয়ারের ইমেল আপনার অ্যাকাউন্টের ইমেলের সাথে মিলে যায়, ইস্যুয়ার স্বতঃ-যাচাইকৃত হয়।
  • যদি ইমেল ভিন্ন হয়, ইস্যুয়ার ইমেলে একটি যাচাইকরণ ইমেল পাঠানো হয়।

ইস্যুয়ার তালিকা

আপনার তৈরি করা সমস্ত ইস্যুয়ার পুনরুদ্ধার করুন।

GET /issuers

উদাহরণ

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

প্রতিক্রিয়া

json
{
  "statusCode": 200,
  "info": {
    "issuers": [
      {
        "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": "2025-01-15T10:30:00.000Z"
      }
    ]
  }
}

ইস্যুয়ার যাচাই

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

POST /issuers/{issuerId}/verify

প্যারামিটার

প্যারামিটারপ্রকারপ্রয়োজনীয়বিবরণ
issuerIdstringহ্যাঁইস্যুয়ার ID (পথ প্যারামিটার)
codestringহ্যাঁইমেল থেকে যাচাইকরণ কোড

উদাহরণ

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

প্রতিক্রিয়া

json
{
  "statusCode": 200,
  "info": {
    "verified": true
  }
}

ইস্যুয়ার মুছুন

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

DELETE /issuers/{issuerId}

উদাহরণ

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

প্রতিক্রিয়া

json
{
  "statusCode": 200,
  "info": {
    "deleted": true
  }
}

ত্রুটি

  • 400 — ইস্যুয়ারের ব্যাজ বা অ্যাওয়ার্ড আছে এবং মুছে ফেলা যাবে না (প্রথমে সেগুলি মুছুন)
  • 404 — ইস্যুয়ার পাওয়া যায়নি

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

একটি অযাচাইকৃত ইস্যুয়ারের ক্ষেত্র আপডেট করুন। একবার একটি ইস্যুয়ার যাচাই হয়ে গেলে, ক্রেডেনশিয়াল স্থিতিশীলতা সংরক্ষণ করতে শুধুমাত্র logo এবং linkedinOrganizationId সম্পাদনাযোগ্য থাকে।

PUT /issuers/{issuerId}

প্যারামিটার

প্যারামিটারপ্রকারপ্রয়োজনীয়বিবরণ
issuerIdstringহ্যাঁইস্যুয়ার ID (পথ প্যারামিটার)
namestringনানতুন নাম (শুধু অযাচাইকৃত অবস্থায়)
urlstringনানতুন URL (শুধু অযাচাইকৃত অবস্থায়)
emailstringনানতুন ইমেল (শুধু অযাচাইকৃত অবস্থায় — একটি নতুন যাচাইকরণ মেল পাঠায়)
logostringনানতুন base64-এনকোডেড লোগো
linkedinOrganizationIdstringনানতুন LinkedIn সংস্থা ID (বা সাফ করতে খালি স্ট্রিং)

যাচাইকরণ কোড রোটেট

পূর্ববর্তী যাচাইকরণ লিঙ্ক অবৈধ করুন এবং একটি নতুন ইমেল করুন। শুধুমাত্র তখন বৈধ যখন ইস্যুয়ার এখনও অযাচাইকৃত।

POST /issuers/{issuerId}/rotate-code

প্রতিক্রিয়া

json
{
  "statusCode": 200,
  "info": {
    "sent": true
  }
}

badges.ninja Documentation