Awards API

ব্যাজ অ্যাওয়ার্ড (অ্যাসার্শন) তৈরি ও পরিচালনা করুন — নির্দিষ্ট প্রাপকদের জারি করা ব্যাজ।

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

অ্যাওয়ার্ড তৈরি করা

একজন প্রাপকের কাছে একটি ব্যাজ জারি করুন।

POST /awards

প্যারামিটার

প্যারামিটার	প্রকার	প্রয়োজনীয়	বিবরণ
badgeId	string	হ্যাঁ	প্রদান করার ব্যাজের ID
recipient	object	হ্যাঁ	প্রাপকের বিবরণ (নীচে দেখুন)
recipient.name	string	হ্যাঁ	প্রাপকের সম্পূর্ণ নাম (ন্যূনতম 5 অক্ষর)
recipient.email	string	হ্যাঁ	প্রাপকের ইমেল ঠিকানা
issuedOn	string	হ্যাঁ	ISO 8601 ফরম্যাটে জারির তারিখ (যেমন 2025-01-15)
expires	string	না	ISO 8601 ফরম্যাটে মেয়াদ শেষের তারিখ
blockchain	string	না	অন-চেইন যাচাইকরণের জন্য ব্লকচেইন। শুধুমাত্র matchain সমর্থিত। Pro প্ল্যানে উপলব্ধ।

উদাহরণ

curl -X POST https://api.badges.ninja/awards \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "recipient": {
        "name": "Jane Smith",
        "email": "jane@example.com"
      },
      "issuedOn": "2025-01-15"
    }
  }'

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

{
  "statusCode": 200,
  "info": {
    "awardId": "https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012"
  }
}

নোট

• আপনার মাসিক কোটার বিরুদ্ধে একটি অ্যাওয়ার্ড হিসাবে গণ্য হয় (Free: 100/mo, Starter: 1,000/mo, Pro: 10,000/mo)। কোটা প্রতিটি বিলিং সময়ে রিসেট হয়।
• blockchain প্যারামিটার শুধুমাত্র Pro প্ল্যানে উপলব্ধ।

---

অ্যাওয়ার্ড তালিকা

ঐচ্ছিক ফিল্টারিং ও পেজিনেশন সহ অ্যাওয়ার্ডগুলি পুনরুদ্ধার করুন।

GET /awards

ক্যোয়ারী প্যারামিটার

প্যারামিটার	প্রকার	প্রয়োজনীয়	বিবরণ
filter	JSON string	না	ফিল্টার অবজেক্ট (নীচে দেখুন)
lastEvaluatedKey	string	না	পূর্ববর্তী প্রতিক্রিয়া থেকে পেজিনেশন টোকেন

ফিল্টার অবজেক্ট

filter প্যারামিটার এই ক্ষেত্রগুলি সহ একটি JSON স্ট্রিং গ্রহণ করে:

ক্ষেত্র	প্রকার	বিবরণ
badgeId	string	ব্যাজ ID দ্বারা ফিল্টার করুন।
search	string	প্রাপকের নাম বা ইমেলে সন্ধানের জন্য সাবস্ট্রিং (searchField দেখুন)।
searchField	string	হয় name (ডিফল্ট) বা email — অনুসন্ধানের জন্য কলাম।

lastEvaluatedKey এর মাধ্যমে পেজিনেশন ফিল্টার সহ বা ছাড়া কাজ করে। পৃষ্ঠার আকার 50।

উদাহরণ — সমস্ত অ্যাওয়ার্ড তালিকা

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

উদাহরণ — ব্যাজ দ্বারা ফিল্টার

curl -X GET "https://api.badges.ninja/awards?filter=%7B%22badgeId%22%3A%22b1c2d3e4%22%7D" \
  -H "X-Api-Key: bws_your_api_key_here"

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

{
  "statusCode": 200,
  "info": {
    "awards": [
      {
        "id": "https://api.badges.ninja/certify-badge/award/c1d2e3f4-...",
        "badge": {
          "id": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
          "name": "JavaScript Fundamentals",
          "image": "https://ipfs.ninja/ipfs/Qm..."
        },
        "recipient": {
          "name": "Jane Smith",
          "email": "jane@example.com"
        },
        "issuedOn": "2025-01-15T00:00:00.000Z",
        "timestamp": "2025-01-15T10:30:00.000Z"
      }
    ],
    "lastEvaluatedKey": "eyJ..."
  }
}

যদি প্রতিক্রিয়ায় lastEvaluatedKey উপস্থিত থাকে, আরও ফলাফল রয়েছে। পরবর্তী পৃষ্ঠা পেতে এটি পরবর্তী অনুরোধে একটি ক্যোয়ারী প্যারামিটার হিসাবে পাস করুন।

---

অ্যাওয়ার্ড ইমেল পাঠান

একজন প্রাপকের কাছে তাদের অ্যাওয়ার্ড সম্পর্কে একটি ইমেল বিজ্ঞপ্তি পাঠান।

POST /awards/{awardId}/send

প্যারামিটার

প্যারামিটার	প্রকার	প্রয়োজনীয়	বিবরণ
awardId	string	হ্যাঁ	অ্যাওয়ার্ড ID (পথ প্যারামিটার এবং বডি)
email	string	হ্যাঁ	প্রাপকের ইমেল ঠিকানা

উদাহরণ

curl -X POST https://api.badges.ninja/awards/c1d2e3f4-a5b6-7890-cdef-123456789012/send \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "awardId": "c1d2e3f4-a5b6-7890-cdef-123456789012",
      "email": "jane@example.com"
    }
  }'

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

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

---

অ্যাওয়ার্ড শেয়ার

ইমেলের মাধ্যমে একাধিক প্রাপকের সাথে একটি অ্যাওয়ার্ড শেয়ার করুন।

POST /awards/{awardId}/share

প্যারামিটার

প্যারামিটার	প্রকার	প্রয়োজনীয়	বিবরণ
awardId	string	হ্যাঁ	অ্যাওয়ার্ড ID (পথ প্যারামিটার এবং বডি)
recipients	string	হ্যাঁ	ইমেল ঠিকানার কমা-বিভক্ত তালিকা
subject	string	হ্যাঁ	ইমেল বিষয় লাইন
message	string	হ্যাঁ	ইমেল বার্তা বডি

উদাহরণ

curl -X POST https://api.badges.ninja/awards/c1d2e3f4-a5b6-7890-cdef-123456789012/share \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "awardId": "c1d2e3f4-a5b6-7890-cdef-123456789012",
      "recipients": "manager@example.com,hr@example.com",
      "subject": "Check out my new badge!",
      "message": "I just earned the JavaScript Fundamentals badge."
    }
  }'

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

{
  "statusCode": 200,
  "info": {
    "shared": true
  }
}

---

PDF সার্টিফিকেট ডাউনলোড

একটি অ্যাওয়ার্ডের জন্য একটি প্রিন্ট-প্রস্তুত A4 PDF সার্টিফিকেট জেনারেট করুন।

GET /awards/{awardGuid}/pdf

কোনো প্রমাণীকরণ প্রয়োজন নেই — এই এন্ডপয়েন্টটি পাবলিক তাই প্রাপকরা তাদের নিজস্ব সার্টিফিকেট ডাউনলোড করতে পারেন।

উদাহরণ

curl -OJ https://api.badges.ninja/awards/c1d2e3f4-a5b6-7890-cdef-123456789012/pdf

প্রতিক্রিয়া হলো Content-Type: application/pdf হেডার সহ বাইনারি PDF।

---

অ্যাওয়ার্ড ইভেন্ট ট্র্যাক

একটি এনগেজমেন্ট ইভেন্ট রেকর্ড করুন (view, share, download, LinkedIn add)। এনগেজমেন্ট পরিসংখ্যান পূরণ করতে পাবলিক অ্যাওয়ার্ড পৃষ্ঠা দ্বারা ব্যবহৃত। কোনো প্রমাণীকরণ প্রয়োজন নেই।

POST /awards/{awardGuid}/event

প্যারামিটার

প্যারামিটার	প্রকার	প্রয়োজনীয়	বিবরণ
kind	string	হ্যাঁ	এর মধ্যে একটি view, share, download, linkedin_add।
network	string	না	যখন kind=share, সোশ্যাল নেটওয়ার্ক: linkedin, twitter, facebook, whatsapp, telegram, email, copy।

প্রতি-IP ডুপ্লিকেট দমন: একই IP থেকে একই kind প্রতি 24 ঘণ্টায় একবার গণনা করা হয়।

উদাহরণ

curl -X POST https://api.badges.ninja/awards/c1d2e3f4-a5b6-7890-cdef-123456789012/event \
  -H "Content-Type: application/json" \
  -d '{"parameters": {"kind": "share", "network": "linkedin"}}'

---

অ্যাওয়ার্ড পরিসংখ্যান পান

একটি অ্যাওয়ার্ডের জন্য ক্রমবর্ধমান এনগেজমেন্ট কাউন্টার পুনরুদ্ধার করুন।

GET /awards/{awardGuid}/stats

কোনো প্রমাণীকরণ প্রয়োজন নেই।

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

{
  "statusCode": 200,
  "info": {
    "stats": {
      "views": 142,
      "shares": { "linkedin": 8, "twitter": 2, "email": 1, "copy": 5 },
      "downloads": 3,
      "linkedin_adds": 4
    }
  }
}