API কী

API কী ব্যবহার করে আপনি badges.ninja REST API-তে প্রোগ্রাম্যাটিকভাবে অ্যাক্সেস পেতে পারেন। আপনার নিজস্ব অ্যাপ্লিকেশন থেকে ব্যাজ তৈরি, ইস্যু ও ব্যবস্থাপনা স্বয়ংক্রিয় করতে এগুলো ব্যবহার করুন।

একটি API কী তৈরি করা

1. সাইডবার থেকে API Keys পৃষ্ঠা খুলুন।
2. Create API Key এ ক্লিক করুন। একটি ইনলাইন ফর্ম খুলবে:

3. কী-টির একটি নাম দিন এবং Create এ ক্লিক করুন। সম্পূর্ণ কী-টি একটি সবুজ ব্যানারে একবারই দেখানো হবে:

4. কী-টি এখনই কপি করুন — সম্পূর্ণ কী শুধু একবারই দেখানো হয়। হারিয়ে ফেললে আপনাকে নতুন একটি তৈরি করতে হবে। ব্যানারটি বন্ধ করার পর ড্যাশবোর্ডে কেবল কী-এর প্রিফিক্স দেখানো হয় (যেমন bws_a1b2c3d4...); আপনার অনুরোধ প্রমাণীকরণের জন্য সম্পূর্ণ কী সার্ভারে সংরক্ষিত থাকে:

প্রতিটি সারিতে কী কখন তৈরি হয়েছিল তা দেখানো হয়, এবং ব্যবহৃত হওয়ার পর একটি last used টাইমস্ট্যাম্পও থাকে, যাতে আপনি অব্যবহৃত কী চিহ্নিত করতে পারেন।

অ্যাক্সেস স্কোপ

কী তৈরির সময় আপনি এটিকে read-only করতে পারেন অথবা পূর্ণ অ্যাক্সেস রাখতে পারেন:

স্কোপ	অনুমোদন করে
পূর্ণ অ্যাক্সেস (ডিফল্ট)	পড়া এবং লেখা — ডেটা তালিকাভুক্ত করা এবং তৈরি, ইস্যু, আপডেট বা মুছে ফেলা।
Read-only	শুধুমাত্র নিরাপদ GET অনুরোধ। ডেটা পরিবর্তন করে এমন যেকোনো অনুরোধ (POST, PUT, PATCH, DELETE) 403 Forbidden দিয়ে প্রত্যাখ্যাত হয়।

যেসব ইন্টিগ্রেশনের শুধু আপনার ডেটা পড়া দরকার (রিপোর্টিং, ড্যাশবোর্ড, ব্যাকআপ), সেগুলোর জন্য read-only কী ব্যবহার করুন, যাতে কী ফাঁস হলেও কিছু পরিবর্তন করা না যায়। তৈরির ফর্মে Read-only key টিক দিন; read-only কী তালিকায় একটি Read-only ব্যাজ দেখায়। স্কোপ চালুর আগে তৈরি কী-গুলো পূর্ণ অ্যাক্সেস বজায় রাখে।

কী-এর ফরম্যাট

API কী bws_ প্রিফিক্স দিয়ে শুরু হয়, তারপর ৩২ অক্ষরের হেক্স স্ট্রিং থাকে:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

অনুরোধে API কী ব্যবহার করা

প্রতিটি API অনুরোধের X-Api-Key হেডারে API কী অন্তর্ভুক্ত করুন:

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

API প্রমাণীকরণ সম্পর্কে বিস্তারিত জানতে প্রমাণীকরণ পৃষ্ঠাটি দেখুন।

প্ল্যান অনুযায়ী কী-এর সীমা

আপনি কতগুলো API কী তৈরি করতে পারবেন তা আপনার প্ল্যানের উপর নির্ভর করে:

প্ল্যান	API কী-এর সীমা
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

কী-এর মেয়াদ

প্রতিটি API কী তৈরির এক বছর পর মেয়াদোত্তীর্ণ হয়। মেয়াদ শেষ হলে কী-টি আর অনুরোধ প্রমাণীকরণ করে না, ঠিক যেন এটি মুছে ফেলা হয়েছে। বিঘ্ন এড়াতে পুরনো কী-এর মেয়াদ শেষ হওয়ার আগেই নতুন কী তৈরি করুন।

একটি কী মুছে ফেলা

1. API Keys পৃষ্ঠা খুলুন।
2. যে কী-টি মুছতে চান সেটি খুঁজে নিন।
3. Delete এ ক্লিক করুন।
4. মুছে ফেলা নিশ্চিত করুন।

মুছে ফেলার সাথে সাথেই কী-টি কাজ করা বন্ধ করে দেয়। ওই কী ব্যবহারকারী যেকোনো অ্যাপ্লিকেশন প্রমাণীকরণ ত্রুটি পাবে।